When disk signature invalid try the next LUN instead of giving up on the entire port

.github/actions/action.yml

@@ -0,0 +1,8 @@
+name: 'Make Nintendont'
+description: 'Compiles Nintendont'
+
+runs:
+  using: 'docker'
+  # Oldest tag I can find with both devkitARM and devkitPPC.
+  image: 'devkitpro/devkitppc:20210619'
+  entrypoint: make

.github/workflows/main.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Compile Nintendont
+      uses: ./.github/actions
+    # The build process updates NintendontVersion.h with minor version set to be
+    # the GitHub CI workflow number. More importantly, we get the main binary,
+    # loader.dol. Both of them needs to be committed back to the repo because
+    # the online update feature fetches directly from the repo. Assume major
+    # version is 7, update common/include/NintendontVersion.h too for a major
+    # version change.
+    - name: Commit loader.dol
+      run: |
+        git config user.name '${{ github.actor }}'
+        git config user.email '${{ github.actor }}@users.noreply.github.com'
+        git add -f loader/loader.dol common/include/NintendontVersion.h
+        ( git commit -m "loader.dol v7.${{ github.run_number }}" && git push ) || true
+    - uses: actions/upload-artifact@v1
+      with: 
+        name: Nintendont
+        path: build/

.gitignore

@@ -2,11 +2,11 @@
 *.o
 *.bin
 *.elf
+build/
 codehandler/*.h
 kernel/asm/*.h
 kernel/kernel.map
 loader/build/
 loader/data/kernel.zip
-nintendont/boot.dol
 fatfs/*.a
-codehandler/*.h
+codehandler/*.h

Makefile

@@ -15,11 +15,23 @@ SUBPROJECTS := multidol kernel/asm resetstub \
 	fatfs/libfat-arm.a fatfs/libfat-ppc.a \
 	codehandler kernel kernelboot \
 	loader/source/ppc/PADReadGC loader/source/ppc/IOSInterface loader
+# This is where titles.txt and icon.png will be copied to
+ARTIFACTS := build/app/Nintendont
+NINTENTDONTVERSION_H := common/include/NintendontVersion.h
 .PHONY: all forced clean $(SUBPROJECTS)
 
-all: loader
+all: nintendontversion loader copy_files
 forced: clean all
 
+# change version number
+nintendontversion:
+	@echo " "
+	@echo "Update version number (if available)"
+	@echo " "
+	if [ -n "$(GITHUB_RUN_NUMBER)" ]; then \
+		sed -i 's/#define NIN_MINOR_VERSION.*$$/#define NIN_MINOR_VERSION\t\t\t$(GITHUB_RUN_NUMBER)/' $(NINTENTDONTVERSION_H); \
+	fi
+
 multidol:
 	@echo " "
 	@echo "Building Multi-DOL loader"
@@ -86,6 +98,16 @@ loader: multidol resetstub fatfs/libfat-ppc.a kernel kernelboot loader/source/pp
 	@echo " "
 	$(MAKE) -C loader
 
+# After building, assemble a build directory. GitHub will zip it and it can be
+# downloaded and extracted to a SD card or HDD.
+copy_files:
+	@echo " "
+	@echo "Copying files"
+	@echo " "
+	mkdir -p $(ARTIFACTS)
+	cp -p nintendont/icon.png nintendont/titles.txt $(ARTIFACTS)
+	unzip -d build/controllers -q -n controllerconfigs/controllers.zip
+
 clean:
 	@echo " "
 	@echo "Cleaning all subprojects..."

common/include/Metadata.h

@@ -4,9 +4,11 @@
 
 #define META_NAME			"Nintendont"
 #define META_AUTHOR			"FIX94, crediar"
-
-#define META_LONG1			"Commiters: GerbilSoft, JoostinOnline, GreyRogue, Howard, Cyan \r\n\r\n Project website: https://github.com/FIX94/Nintendont "
-#define META_LONG2			"Nintendont allows you to run GameCube games on a Wii or Wii U from an SD or HDD device."
+#if !defined(META_DATETIME)
+#   define META_DATETIME    "20160710000000"
+#endif
+#define META_LONG1  		"Nintendont allows you to run GameCube games on a Wii or Wii U from an SD or HDD device."
+#define META_LONG2		    " Project website: https://github.com/FIX94/Nintendont\r\n\r\nCommitters: GerbilSoft, JoostinOnline, GreyRogue, Howard, Cyan, nastys, carnage702, AnthonyRyuki, DankRank, Chickoodel, akemin-dayo, SuperrSonic, KoldMonster12, cheatfreak47, capnfunky77, cesarmades, crazycaveman, Wolfy76700, AndyCasaceli, ShadowOne333, Aurelio92, darkalemanbr, jmapjp, sailormoon, Dr-Crow, cyberstudio10, corey-underdown"
 #define META_SHORT			"Gamecube Loader"
 
 #define META_XML			"<?xml version=\"1.0\" encoding=\"ISO-8859-1\" standalone=\"yes\"?>"

common/include/NintendontVersion.h

@@ -1,8 +1,11 @@
 #ifndef __NINTENDONT_VERSION_H__
 #define __NINTENDONT_VERSION_H__
 
-#define NIN_MAJOR_VERSION			6
-#define NIN_MINOR_VERSION			498
+/* Minor version to be automatically filled in by GitHub CI. Any major version
+ * change will have to update main.yml. Online updates fetch this file directly
+ * from the repo and scanf these version numbers. */
+#define NIN_MAJOR_VERSION			7
+#define NIN_MINOR_VERSION			12
 
 #define NIN_VERSION		((NIN_MAJOR_VERSION << 16) | NIN_MINOR_VERSION)
 

loader/Makefile

@@ -15,21 +15,34 @@ include $(DEVKITPPC)/wii_rules
 # BUILD is the directory where object files & intermediate files will be placed
 # SOURCES is a list of directories containing source code
 # INCLUDES is a list of directories containing extra header files
+# ARTIFACTS is to package a zip for the user to unpack to their SD card/HDD
 #---------------------------------------------------------------------------------
 TARGET		:= $(notdir $(CURDIR))
 BUILD		:= build
 SOURCES		:= source
 SOURCES		+= source/unzip
 DATA		:= data
 INCLUDES	:= include ../fatfs
+ARTIFACTS	:= ../build/apps/Nintendont
+NINTENTDONTVERSION_H := ../common/include/NintendontVersion.h
+
+#---------------------------------------------------------------------------------
+# metadata
+#---------------------------------------------------------------------------------
+# If dol does not come from FIX94 we identify source on the screen
+NIN_SPECIAL_VERSION	:=	$(if $(and $(GITHUB_REPOSITORY_OWNER),$(findstring FIX94,$(GITHUB_REPOSITORY_OWNER))),,\"-$(GITHUB_REPOSITORY_OWNER)\")
+# As preprocessor defines, DATETIME is unquoted, META_DATETIME is quoted
+DATETIME			:=	$(shell git show -s --format=%cI | grep -o -E "[[:digit:]]*" - | head -n 6 | paste -sd '')
 
 #---------------------------------------------------------------------------------
 # options for code generation
 #---------------------------------------------------------------------------------
 
 ASFLAGS := $(MACHDEP) -mregnames -D_LANGUAGE_ASSEMBLY
 CFLAGS	:= -O3 -g -std=gnu89 -Wno-format-truncation \
-	   -Wall $(MACHDEP) $(INCLUDE) -DDEBUG -DDEBUG_MODULE_PATCH -DARCH_IS_BIG_ENDIAN
+	   -Wall $(MACHDEP) $(INCLUDE) -DDEBUG -DDEBUG_MODULE_PATCH -DARCH_IS_BIG_ENDIAN \
+	   -DNIN_SPECIAL_VERSION=$(NIN_SPECIAL_VERSION) \
+	   -DMETA_DATETIME=\"$(DATETIME)\"
 CXXFLAGS := $(CFLAGS)
 
 # NOTE: Do NOT change to := - needed for proper expansion of $(CURDIR) later.
@@ -103,10 +116,19 @@ export OUTPUT	:=	$(CURDIR)/$(TARGET)
 .PHONY: $(BUILD) clean
 
 #---------------------------------------------------------------------------------
+# 1, build loader.dol
+# 2, output meta.xml using C preprocessor on a template
 $(BUILD):
 	@[ -d $@ ] || mkdir -p $@
 	@$(MAKE) --no-print-directory -C $(BUILD) -f $(CURDIR)/Makefile
-	@cp $(OUTPUT).dol ../nintendont/boot.dol
+	@[ -d $(ARTIFACTS) ] || mkdir -p $(ARTIFACTS)
+	@cp -p $(OUTPUT).dol $(ARTIFACTS)/boot.dol
+	$(CC) -E -traditional -P \
+		-include $(NINTENTDONTVERSION_H) \
+		-DDATETIME=$(DATETIME) \
+		../metaxml.sx \
+		| sed -n '/^<?xml/,$$p' \
+		> $(ARTIFACTS)/meta.xml
 
 #---------------------------------------------------------------------------------
 clean:

loader/source/main.c

@@ -151,7 +151,7 @@ static void updateMetaXml(void)
 		"\t<name>" META_NAME "</name>\r\n"
 		"\t<coder>" META_AUTHOR "</coder>\r\n"
 		"\t<version>%d.%d%s</version>\r\n"
-		"\t<release_date>20160710000000</release_date>\r\n"
+		"\t<release_date>" META_DATETIME "</release_date>\r\n"
 		"\t<short_description>" META_SHORT "</short_description>\r\n"
 		"\t<long_description>" META_LONG1 "\r\n\r\n" META_LONG2 "</long_description>\r\n"
 		"\t<no_ios_reload/>\r\n"

loader/source/usbstorage.c

@@ -946,27 +946,31 @@ static bool __usbstorage_IsInserted(void)
 			// If not, it might be a Wii U drive.
 			retval = USBStorageOGC_Read(&__usbfd, __lun, 0, 1, sector_buf);
 			if (retval == 0) {
-				if (sector_buf[510] == 0x55 &&
-				    (sector_buf[511] == 0xAA || sector_buf[511] == 0xAB))
-				{
-					// Valid MBR and/or UStealth signature.
-					__mounted = true;
-					__vid = vid;
-					__pid = pid;
-					usb_last_used = gettime()-secs_to_ticks(100);
-					usleep(10000);
-				} else {
-					// Invalid signature.
+				// discard first read. I've seen a controller so buggy which returns the boot sector of LUN 1 when that of LUN 0 is asked for.
+				usb_last_used = gettime()-secs_to_ticks(100);
+				usleep(10000);
+				retval = USBStorageOGC_Read(&__usbfd, __lun, 0, 1, sector_buf);
+				if (retval == 0) {
+					if (sector_buf[510] == 0x55 &&
+					    (sector_buf[511] == 0xAA || sector_buf[511] == 0xAB))
+					{
+						// Valid MBR and/or UStealth signature.
+						__mounted = true;
+						__vid = vid;
+						__pid = pid;
+						usb_last_used = gettime()-secs_to_ticks(100);
+						usleep(10000);
+						break;	// found valid signature. Done!
+					}
+					// Else invalid signature.
 					// This may be a Wii U-formatted HDD.
-					__mounted = false;
-					__lun = 0;
 				}
-			} else {
-				// Read error.
-				__mounted = false;
-				__lun = 0;
+				// Else read error.
 			}
-			break;
+			// Else read error.
+			__mounted = false;
+			__lun = 0;
+			// continue scanning for next LUN instead of giving up
 		}
 
 		if (__mounted)

metaxml.sx

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
+<app version="1">
+	<name>Nintendont</name>
+	<coder>FIX94, crediar</coder>
+	<version>NIN_MAJOR_VERSION.NIN_MINOR_VERSION</version>
+	<release_date>DATETIME</release_date>
+	<short_description>Gamecube Loader</short_description>
+	<long_description>Nintendont allows you to run GameCube games on a Wii or Wii U from an SD or HDD device.
+
+ Project website: https://github.com/FIX94/Nintendont 
+
+Committers: GerbilSoft, JoostinOnline, GreyRogue, Howard, Cyan, nastys, carnage702, AnthonyRyuki, DankRank, Chickoodel, akemin-dayo, SuperrSonic, KoldMonster12, cheatfreak47, capnfunky77, cesarmades, crazycaveman, Wolfy76700, AndyCasaceli, ShadowOne333, Aurelio92, darkalemanbr, jmapjp, sailormoon, Dr-Crow, cyberstudio10, corey-underdown</long_description>
+	<no_ios_reload/>
+	<ahb_access/>
+</app>