mbr: implement support for loading OSD and config file paths

Author: pcm720

common/include/defaults.h

@@ -26,6 +26,11 @@
 // Partition containing DKWDRV
 #define HOSD_SYS_PARTITION "hdd0:__system"
 
+// Path relative to HOSD_SYS_PARTITION root
+#ifndef HOSDMBR_CONF_PATH
+#define HOSD_PFS_PATH "/osdmenu/hosdmenu.elf"
+#endif
+
 // Path relative to HOSD_CONF_PARTITION root
 #ifndef HOSD_CONF_PATH
 #define HOSD_CONF_PATH "/osdmenu/OSDMENU.CNF"
@@ -41,4 +46,18 @@
 #define HOSD_DKWDRV_PATH HOSD_SYS_PARTITION ":pfs:/osdmenu/DKWDRV.ELF"
 #endif
 
+//
+// HDD-OSD and PSBBN paths, relative to SYSTEM_PARTITION root
+//
+
+// System partition
+#define SYSTEM_PARTITION "hdd0:__system"
+
+// HDD-OSD
+#define HOSDSYS_PFS_PATH_1 "/osd100/hosdsys.elf"
+#define HOSDSYS_PFS_PATH_2 "/osd100/OSDSYS_A.XLF"
+
+// PSBBN launcher path
+#define OSDBOOT_PFS_PATH "/p2lboot/osdboot.elf"
+
 #endif

examples/OSDMBR.CNF

@@ -0,0 +1,22 @@
+boot_auto = $PSBBN
+boot_auto = $HOSDSYS
+boot_auto_arg1 =
+boot_start = hdd0:__common:pfs:/Apps/APP_NHDDL/nhddl.elf
+boot_start = mc0:/APP_NHDDL/nhddl.elf
+boot_start_arg1 = -mode=mmce
+boot_start_arg2 = -video=480p
+boot_triangle = hdd0:__common/Apps/BOOT/BOOT.ELF
+boot_triangle_arg1 =
+boot_circle = mc?:/BOOT/BOOT.elf
+boot_circle_arg1 =
+boot_cross = cdrom
+boot_cross_arg1 =
+boot_square = rom0:OSDSYS
+boot_square_arg1 =
+cdrom_skip_ps2logo = 1
+cdrom_disable_gameid = 0
+cdrom_use_dkwdrv = 0
+ps1drv_enable_fast = 0
+ps1drv_enable_smooth = 0
+ps1drv_use_ps1vn = 0
+prefer_bbn = 0

mbr/Makefile

@@ -10,7 +10,7 @@ EE_LINKFILE = linkfile
 
 EE_INCS = -I$(PS2SDK)/ee/include -I$(PS2SDK)/common/include -I$(PS2SDK)/sbv/include  -I$(PS2DEV)/gsKit/include -I$(PS2SDK)/ports/include  -Iinclude -I../common/include
 EE_LIBS = -lpatches -ldma -ldebug -lfileXio -lsecr -lpad -lgskit -ldmakit -lmc
-EE_OBJS =  main.o init.o config.o mbrboot_crypto.o loader.o hdd.o hdd_start.o common.o disc.o
+EE_OBJS =  main.o init.o config.o crypto.o loader.o hdd.o patinfo.o common.o disc.o
 ELF_FILES = loader.elf ps1vn.elf
 IRX_FILES = iomanX.irx fileXio.irx ps2dev9.irx ps2atad.irx ps2hdd-osd.irx ps2fs.irx secrsif.irx
 
@@ -21,7 +21,7 @@ RES_FILES += icon_A.sys icon_C.sys icon_J.sys
 # C compiler flags
 EE_CFLAGS := -D_EE -O2 -G0 -Wall $(EE_CFLAGS)
 EE_CFLAGS = -D_EE -Os -G0 -Wall -Werror -fdata-sections -ffunction-sections $(EE_INCS)
-EE_LDFLAGS += -Wl,-zmax-page-size=128 -Wl,--gc-sections # -s
+EE_LDFLAGS += -Wl,-zmax-page-size=128 -Wl,--gc-sections -s
 EE_LDFLAGS += -L$(PS2DEV)/gsKit/lib
 
 # Reduce binary size by using newlib-nano
@@ -32,20 +32,10 @@ EE_OBJS_DIR = obj/
 EE_ASM_DIR = asm/
 EE_SRC_DIR = src/
 
-ifeq ($(PAYLOAD),patcher.elf)
-	EE_CFLAGS += -DHOSDMENU
-endif
-
 ifeq ($(ENABLE_PRINTF), 1)
  EE_CFLAGS += -DENABLE_PRINTF
 endif
 
-ifneq (,$(findstring ELF,$(PAYLOAD)))
-	EE_OBJS += $(PAYLOAD:.ELF=_ELF.o)
-else
-	EE_OBJS += $(PAYLOAD:.elf=_elf.o)
-endif
-
 EE_OBJS += $(IRX_FILES:.irx=_irx.o)
 EE_OBJS += $(ELF_FILES:.elf=_elf.o)
 EE_OBJS += $(RES_FILES:.sys=_sys.o)
@@ -66,19 +56,6 @@ clean:
 %ps2hdd-osd_irx.c:
 	$(BIN2C) $(PS2SDK)/iop/irx/ps2hdd-osd.irx $@ $(*:$(EE_SRC_DIR)%=%)ps2hdd_osd_irx
 
-# HOSDMenu payload
-%patcher_elf.c:
-	$(MAKE) -C ../patcher clean
-	$(MAKE) -C ../patcher HOSD=1
-	$(BIN2C) ../patcher/patcher.elf $@ payload_elf
-
-# Custom payload
-%_elf.c:
-	$(BIN2C) $(*:$(EE_SRC_DIR)%=%).elf $@ payload_elf
-
-%_ELF.c:
-	$(BIN2C) $(*:$(EE_SRC_DIR)%=%).ELF $@ payload_elf
-
 # ELF loader
 loader.elf:
 	$(MAKE) -C ../utils/loader/$<

mbr/include/common.h

@@ -7,6 +7,20 @@ int checkFile(char *path);
 // Displays the message on the screen
 void msg(const char *str, ...);
 
+// Displays the fatal error message on the screen
+void fatalMsg(char *str);
+
+// Starts HOSDMenu or HDD-OSD.
+// Assumes the system partition is already mounted and argv has space for the additional -mbrboot argument.
+// Will unmount the partition.
+int startHOSDSYS(int argc, char *argv[]);
+
+// Attempts to launch PSBBN, HOSDMenu or HOSDSYS. Falls back to OSDSYS
+int execOSD(int argc, char *argv[]);
+
+// Shuts down HDD, dev9 and exits to OSD with arguments
+void bootFailWithArgs(char *msg, int argc, char *argv[]);
+
 // Shuts down HDD, dev9 and exits to OSDSYS
 void bootFail(char *msg);
 

mbr/include/config.h

@@ -10,6 +10,7 @@ typedef enum {
   FLAG_PS1DRV_FAST = (1 << 3),    // If set, will force PS1DRV fast disc speed
   FLAG_PS1DRV_SMOOTH = (1 << 4),  // If set, will force PS1DRV texture smoothing
   FLAG_PS1DRV_USE_VN = (1 << 5),  // If set, run PS1DRV via the PS1DRV Video Mode Negator
+  FLAG_PREFER_BBN = (1 << 6),     // If set, will attempt to run PSBBN instead of HOSDSYS on OSD errors
 } Flags;
 
 typedef enum {
@@ -31,12 +32,13 @@ typedef struct launchPath {
   TriggerType trigger;
   linkedStr *paths;
   linkedStr *args;
+  int argCount;
   struct launchPath *next;
 } launchPath;
 
 // Settings struct, contains option flags and paths
 typedef struct {
-  uint8_t flags;    // Flags
+  uint8_t flags;     // Flags
   launchPath *paths; // Launch paths
 } Settings;
 

mbr/src/common.c

@@ -1,8 +1,14 @@
+#include "config.h"
+#include "crypto.h"
+#include "defaults.h"
 #include "hdd.h"
+#include "loader.h"
 #include <debug.h>
 #include <fcntl.h>
 #include <kernel.h>
 #include <ps2sdkapi.h>
+#include <stdlib.h>
+#include <string.h>
 
 static int isScreenInited = 0;
 
@@ -38,22 +44,114 @@ void msg(const char *str, ...) {
   va_end(args);
 }
 
-// Shuts down HDD, dev9 and exits to OSDSYS
-void bootFail(char *msg) {
+// Displays the fatal error message on the screen
+void fatalMsg(char *msg) {
   // Display the error message
   initScreen();
   scr_printf("\t\nFatal error:\n\t%s\n", msg);
 
-  // Shutdown dev9
-  shutdownDEV9();
-
   // Delay
   int ret = 0x20000000;
   while (ret--)
     asm("nop\nnop\nnop\nnop");
+}
+
+// Starts HOSDMenu or HDD-OSD.
+// Assumes the system partition is already mounted and argv has space for the additional -mbrboot argument.
+// Will unmount the partition.
+int startHOSDSYS(int argc, char *argv[]) {
+  char *hosdsysPath = NULL;
+  if (checkFile("pfs0:" HOSDSYS_PFS_PATH_1) >= 0)
+    hosdsysPath = SYSTEM_PARTITION ":pfs:" HOSDSYS_PFS_PATH_1;
+  else if (checkFile("pfs0:" HOSDSYS_PFS_PATH_2) >= 0)
+    hosdsysPath = SYSTEM_PARTITION ":pfs:" HOSDSYS_PFS_PATH_2;
+
+  umountPFS();
+
+  if (!hosdsysPath)
+    return -ENOENT;
+
+  argv[0] = hosdsysPath;
+
+  if (!mountPFS(HOSD_SYS_PARTITION)) {
+    int res = checkFile("pfs0:" HOSD_PFS_PATH);
+    umountPFS();
+    if (res >= 0) {
+      // Boot HOSDMenu
+      argv[0] = HOSD_SYS_PARTITION ":pfs:" HOSD_PFS_PATH;
+
+      argv[argc] = "-mbrboot";
+
+      LoadOptions opts = {
+          .dev9ShutdownType = ShutdownType_None,
+          .argc = argc + 1,
+          .argv = argv,
+      };
+      loadELF(&opts);
+      return -ENOENT;
+    }
+  }
+
+  // Boot HOSDSYS
+  LoadOptions opts = {
+      .argc = argc,
+      .argv = argv,
+  };
+  loadELF(&opts);
+  return -ENOENT;
+}
+
+// Attempts to launch PSBBN, HOSDMenu or HOSDSYS. Falls back to OSDSYS
+void execOSD(int argc, char *argv[]) {
+  if (mountPFS(SYSTEM_PARTITION)) {
+    ExecOSD(argc, argv);
+    return;
+  }
+
+  // Ensure we always work with initialized argv array
+  char **nargv = malloc((argc + 2) * sizeof(char *)); // + 2 to store nargv[0] and possible HOSDMenu -mbrboot argument
+  int nargc = argc + 1;
+  nargv[0] = NULL;
+  if (argv && argc > 0)
+    for (int i = 0; i < argc; i++)
+      nargv[i + 1] = argv[i];
+
+  if ((settings.flags & FLAG_PREFER_BBN) && (checkFile("pfs0:" OSDBOOT_PFS_PATH) >= 0)) {
+    // Start PSBBN
+    nargv[0] = SYSTEM_PARTITION ":pfs:" OSDBOOT_PFS_PATH;
+    if (argc > 1) // Encrypt arguments
+      nargv = encryptOSDBOOTArgs(&nargc, nargv);
+
+    LoadOptions opts = {
+        .argc = nargc,
+        .argv = nargv,
+    };
+    loadELF(&opts);
+    return;
+  }
+
+  startHOSDSYS(nargc, nargv);
+
+  // Else, exec OSDSYS
+  // Shutdown dev9
+  shutdownDEV9();
+  argc--;
+  ExecOSD(argc, &argv[1]);
+  return;
+}
+
+// Shuts down HDD, dev9 and exits to OSD with arguments
+void bootFailWithArgs(char *msg, int argc, char *argv[]) {
+  fatalMsg(msg);
 
   // Execute OSDSYS with the "BootError" argument
-  char *args[] = {"BootError"};
-  ExecOSD(1, args);
+  execOSD(argc, argv);
   __builtin_trap();
 }
+
+// Shuts down HDD, dev9 and exits to OSD
+void bootFail(char *msg) {
+  // Execute OSD with the "BootError" argument
+  char *args[] = {"BootError"};
+  bootFailWithArgs(msg, 1, args);
+}

mbr/src/config.c

@@ -125,6 +125,7 @@ int loadConfig() {
         newPath->trigger = btn;
         newPath->paths = NULL;
         newPath->args = NULL;
+        newPath->argCount = 0;
 
         // Insert the path into the list
         if (currentPath)
@@ -136,10 +137,11 @@ int loadConfig() {
         settings.paths = currentPath;
 
       // Check if the option has an _arg suffix
-      if ((optPtr = strrchr(lineBuffer, '_')) && !strncmp(++optPtr, "arg", 3))
+      if ((optPtr = strrchr(lineBuffer, '_')) && !strncmp(++optPtr, "arg", 3)) {
         // Add the argument
         currentPath->args = addStr(currentPath->args, valuePtr);
-      else
+        currentPath->argCount++;
+      } else
         // Add the path
         currentPath->paths = addStr(currentPath->paths, valuePtr);
 
@@ -189,6 +191,13 @@ int loadConfig() {
         settings.flags &= ~(FLAG_PS1DRV_USE_VN);
       continue;
     }
+    if (!strncmp(lineBuffer, "prefer_bbn", 10)) {
+      if (atoi(valuePtr))
+        settings.flags |= FLAG_PREFER_BBN;
+      else
+        settings.flags &= ~(FLAG_PREFER_BBN);
+      continue;
+    }
   }
   fclose(file);
   umountPFS();