krat0s: XPARAM patches

Author: AKuHAK

Makefile

@@ -63,7 +63,7 @@ ifneq ($(GIT_TAG),latest)
 endif
 endif
 
-FRONTEND_OBJS = pad.o fntsys.o renderman.o menusys.o OSDHistory.o system.o lang.o lang_internal.o config.o hdd.o dialogs.o \
+FRONTEND_OBJS = pad.o xparam.o fntsys.o renderman.o menusys.o OSDHistory.o system.o lang.o lang_internal.o config.o hdd.o dialogs.o \
 		dia.o ioman.o texcache.o themes.o supportbase.o bdmsupport.o ethsupport.o hddsupport.o zso.o lz4.o \
 		appsupport.o gui.o guigame.o textures.o opl.o atlas.o nbns.o httpclient.o gsm.o cheatman.o sound.o ps2cnf.o
 

include/xparam.h

@@ -0,0 +1,34 @@
+/*
+#
+# DECKARD Configs
+#--------------------------
+# Copyright 2023 krat0s.
+#
+*/
+
+
+#define GM_IOP_TYPE (0x80000000)
+
+#define PARAM_MDEC_DELAY_CYCLE         (0x00)
+#define PARAM_SPU_INT_DELAY_LIMIT      (0x01)
+#define PARAM_SPU_INT_DELAY_PPC_COEFF  (0x02)
+#define PARAM_SPU2_INT_DELAY_LIMIT     (0x03)
+#define PARAM_SPU2_INT_DELAY_PPC_COEFF (0x04)
+#define PARAM_DMAC_CH10_INT_DELAY      (0x05)
+#define PARAM_CPU_DELAY                (0x06)
+#define PARAM_SPU_DMA_WAIT_LIMIT       (0x07)
+#define PARAM_GPU_DMA_WAIT_LIMIT       (0x08)
+#define PARAM_DMAC_CH10_INT_DELAY_DPC  (0x09)
+#define PARAM_CPU_DELAY_DPC            (0x0A)
+#define PARAM_USB_DELAYED_INT_ENABLE   (0x0B)
+#define PARAM_TIMER_LOAD_DELAY         (0x0C)
+#define PARAM_SIO0_DTR_SCK_DELAY       (0x0D)
+#define PARAM_SIO0_DSR_SCK_DELAY_C     (0x0E)
+#define PARAM_SIO0_DSR_SCK_DELAY_M     (0x0F)
+#define PARAM_MIPS_DCACHE_ON           (0x10)
+#define PARAM_CACHE_FLASH_CHANNELS     (0x11)
+
+#define GM_IF ((vu32 *)0x1F801450)
+
+void ResetDeckardXParams();
+void ApplyDeckardXParam(const char *title);

src/opl.c

@@ -33,6 +33,7 @@
 
 #include "include/cheatman.h"
 #include "include/sound.h"
+#include "include/xparam.h"
 
 // FIXME: We should not need this function.
 //        Use newlib's 'stat' to get GMT time.
@@ -1887,6 +1888,7 @@ int main(int argc, char *argv[])
 
     // reset, load modules
     reset();
+    ResetDeckardXParams();
 
     if (argc >= 5) {
         /* argv[0] boot path
@@ -1899,7 +1901,7 @@ int main(int argc, char *argv[])
         /* argv[0] boot path
            argv[1] file name (including extention)
            argv[2] game->startup
-           argv[3] game->media ("CD" / "DVD") 
+           argv[3] game->media ("CD" / "DVD")
            argv[4] "bdm" */
         if (!strcmp(argv[4], "bdm"))
             autoLaunchBDMGame(argv);

src/system.c

@@ -25,6 +25,7 @@
 #include <osd_config.h>
 #include "include/pggsm.h"
 #include "include/cheatman.h"
+#include "include/xparam.h"
 
 #ifdef PADEMU
 #include <libds34bt.h>
@@ -787,6 +788,8 @@ void sysLaunchLoaderElf(const char *filename, const char *mode_str, int size_cdv
             memset(eph[i].vaddr + eph[i].filesz, 0, eph[i].memsz - eph[i].filesz);
     }
 
+    ApplyDeckardXParam(filename);
+
     // Get the kernel to use our EELOAD module and to begin erasure after module storage. EE core will erase any memory before the module storage (if any).
     if (initKernel((void *)eh->entry, ModuleStorageEnd, &eeloadCopy, &initUserMemory) != 0) { // Should not happen, but...
         LOG("Error - kernel is unsupported.\n");

src/xparam.c

@@ -0,0 +1,246 @@
+/*
+#
+# DECKARD Configs
+#--------------------------
+# Copyright 2023 krat0s.
+#
+*/
+
+#include "include/opl.h"
+#include "include/xparam.h"
+
+char params_DCACHE_OFF[] = {'0', 'x', '1', '0', 0, '0', 0};
+char params_CPU_DELAY[] = {'0', 'x', '6', 0, '0', 'x', '7', '8', '0', 0};
+
+
+int CheckSpecialDiscXParamTitle(const char *title)
+{
+    /*
+    See if we are dealing with any of the special titles so far.
+    Special titles are the ones that have the param specified in the SYSTEM.CNF.
+    To get that value one needs to get XPARAM entry from system.cnf and then verify its integrity.
+    Since all special games are known already and to avoid the whole MD5 checking and everything let's just go the easy way and apply it.
+    Param from the disc always overrides the internal ones so let's do it.
+    PS2 special params from the disc do not apply on PS3/PS4. They instead look for XPARAM4 entry (no game ever found with that one).
+    */
+
+    int result = 0;
+
+    // Another Century's Episode 2 (Japan)
+    result |= !strncmp("SLPS_256.23", title, 11);
+
+    // Critical Velocity (Japan)
+    result |= !strncmp("SLPS_255.32", title, 11);
+
+    // Hissatsu Pachinko Station V11 (Japan)
+    // Hissatsu Pachinko Station V11 - CR Gyaatoruzu (Japan)
+    result |= !strncmp("SLPS_255.56", title, 11);
+
+    // Matantei Loki Ragnarok - Mayouga - Ushinawareta Bishou (Japan)
+    // NOTE: this game has same XPARAM values and hash as the game Ibara.
+    // The md5 check for this does match but for Ibara does not. For sure that Ibara is just a user error due to it being leftover from this game. Both games are from Taito and Ibara came much later.
+    result |= !strncmp("SLPM_661.41", title, 11);
+
+    // Sega Ages 2500 Series Vol. 23 - Sega Memorial Selection (Japan)
+    result |= !strncmp("SLPM_627.09", title, 11);
+
+    // Shin Bakusou Dekotora Densetsu - Tenka Touitsu Choujou Kessen (Japan) (Spike the Best)
+    result |= !strncmp("SLPM_663.87", title, 11);
+
+    return result;
+}
+
+
+void ApplyExtraXParamTitle(const char *title, char *params)
+{
+    int result = 0;
+
+    // Kaidou: Touge no Densetsu (Japan)
+    // This config was added twice in newer XPARAM.
+    result |= !strncmp("SLPM_660.22", title, 11);
+
+    // Duel Masters: Birth of Super Dragon (Japan)
+    result |= !strncmp("SLPM_658.82", title, 11);
+
+    // Shin Bakusou Dekotora Densetsu: Tenka Touitsu Choujou Kessen (Japan)
+    result |= !strncmp("SLPM_658.16", title, 11);
+
+    // Shutokou Battle 01 (Japan)
+    result |= !strncmp("SLPM_653.08", title, 11);
+
+    // Initial D: Special Stage (Japan)
+    result |= !strncmp("SLPM_653.08", title, 11);
+
+    // Bakusou Dekotora Densetsu: Otoko Hanamichi Yume Roman (Japan)
+    result |= !strncmp("SLPM_652.34", title, 11);
+
+    if (result) {
+        // All of them are new added ones and all use 0x10 0 (DCACHE OFF )
+        memcpy(&params[12], params_DCACHE_OFF, 7);
+        SifLoadModule("rom0:XPARAM", 19, params);
+        return;
+    }
+
+
+    result = 0;
+
+    // This new one was for entries already there that had DCACHE off but now even have a CPU_DELAY param added to it.
+
+    // Tekken 5
+    result |= !strncmp("SCAJ_201.25", title, 11);
+    result |= !strncmp("SCAJ_201.26", title, 11);
+    result |= !strncmp("SCKA_200.49", title, 11);
+    result |= !strncmp("SLPS_255.10", title, 11);
+    result |= !strncmp("SLUS_210.59", title, 11);
+
+    if (result) {
+        memcpy(&params[12], params_CPU_DELAY, 10);
+        SifLoadModule("rom0:XPARAM", 22, params);
+        return;
+    }
+
+    // One single game was then added both cache off and CPU delay.
+    if (!strncmp("SCES_532.02", title, 11)) {
+
+        /*
+        Tekken 5 (Australia)
+        Tekken 5 would have the cache off but not the CPU delay, however, this regional release for the first bios of 750xx had neither the cache nor the delay making it run worse.
+        */
+        memcpy(&params[12], params_DCACHE_OFF, 7);
+        SifLoadModule("rom0:XPARAM", 19, params);
+
+        memcpy(&params[12], params_CPU_DELAY, 10);
+        SifLoadModule("rom0:XPARAM", 22, params);
+    }
+}
+
+void ResetDeckardXParams()
+{
+    /*
+    This is needed in the case of IGR because the previous game might have changed XPARAMS and the new game might need the default one.
+    */
+
+    /*
+    Check to see if this is a DECKARD machine or not.
+    Bit 31 of GM_IF is for the IOP type.
+    0 Regular IOP
+    1 DECKARD IOP
+    */
+    if ((*GM_IF & GM_IOP_TYPE) == 0)
+        return;
+
+    int fd;
+    char params[30];
+    memset(params, 0, 30);
+    strncpy(params, "SLPS_123.45", 11);
+    params[11] = 0; // Terminate param string.
+
+    // For PS3/4 emu we skip default.
+    fd = open("rom0:XPARAM2", O_RDONLY);
+    if (fd >= 0) {
+        close(fd);
+        return;
+    }
+
+    u32 default_values[] = {
+        0x01F4, // PARAM_MDEC_DELAY_CYCLE
+        0x07D0, // PARAM_SPU_INT_DELAY_LIMIT
+        0x0023, // PARAM_SPU_INT_DELAY_PPC_COEFF
+        0x07D0, // PARAM_SPU2_INT_DELAY_LIMIT
+        0x0014, // PARAM_SPU2_INT_DELAY_PPC_COEFF
+        0x0000, // PARAM_DMAC_CH10_INT_DELAY
+        0x0001, // PARAM_CPU_DELAY
+        0x0020, // PARAM_SPU_DMA_WAIT_LIMIT
+        0x0000, // PARAM_GPU_DMA_WAIT_LIMIT
+        0x0000, // PARAM_DMAC_CH10_INT_DELAY_DPC
+        0x0000, // PARAM_CPU_DELAY_DPC
+        0x0000, // PARAM_USB_DELAYED_INT_ENABLE
+        0x0000, // PARAM_TIMER_LOAD_DELAY
+        0x229C, // PARAM_SIO0_DTR_SCK_DELAY
+        0x06EC, // PARAM_SIO0_DSR_SCK_DELAY_C
+        0x06EC, // PARAM_SIO0_DSR_SCK_DELAY_M
+        0x0001, // PARAM_MIPS_DCACHE_ON
+        0x0090  // PARAM_CACHE_FLASH_CHANNELS
+    };
+
+    fd = open("rom0:XPARAM", O_RDONLY);
+    if (fd >= 0) {
+        close(fd);
+
+        // Reset all the params to default.
+        int i;
+        for (i = 0; i < 0x12; i++) {
+            sprintf(&params[12], "0X%02X", i);
+            params[16] = 0;
+            sprintf(&params[17], "0X%08X", default_values[i]);
+            params[27] = 0;
+            SifLoadModule("rom0:XPARAM", 28, params);
+        }
+    }
+}
+
+// Note TITLE must be as *IS*, not uppercase or anything.
+void ApplyDeckardXParam(const char *title)
+{
+    int fd;
+
+    // Safety check
+    if (title == NULL)
+        return;
+
+    char params[30];
+    memset(params, 0, 30);
+    strncpy(params, title, 11);
+    params[11] = 0; // Terminate param string.
+
+    /*
+    Check to see if this is a DECKARD machine or not.
+    Bit 31 of GM_IF is for the IOP type.
+    0 Regular IOP
+    1 DECKARD IOP
+    */
+    if ((*GM_IF & GM_IOP_TYPE) == 0)
+        return;
+
+    /*
+    See if this PS3/4 emu and apply the config to it.
+    PS3 and PS4 are missing the regular param file and only have XPARAM2 in them.
+    */
+    fd = open("rom0:XPARAM2", O_RDONLY);
+    if (fd >= 0) {
+        close(fd);
+        SifLoadModule("rom0:XPARAM2", 12, params);
+        return;
+    }
+
+
+    // See if it's the regular PS2 one.
+    fd = open("rom0:XPARAM", O_RDONLY);
+    if (fd >= 0) {
+        close(fd);
+
+        if (CheckSpecialDiscXParamTitle(title)) {
+            // All of them use 0x10 0 (DCACHE OFF)
+            // Params are sent as direct string null separated.
+            memcpy(&params[12], params_DCACHE_OFF, 7);
+            SifLoadModule("rom0:XPARAM", 19, params);
+            return;
+        }
+
+        // Load the default configs found in the XPARAM module.
+        SifLoadModule("rom0:XPARAM", 12, params);
+
+        /*
+        There is a special case here, in all the PS2 bios there are only two XPARAM files.
+        The first one is in bios 2.20 with the date 20050620 and has 272 configs in total.
+        Starting with 2.20 date 20060210 and all later bios up to the final one there is one single XPARAM which has 286 configs.
+        14 configs were added and the previous ones were unchanged.
+        Within those 14 configs, some are for new games, the rest is more params for games that already had one.
+        If we are running into this early bios we will get bad compatibility so let's make it uniform and reapply the extra configs just in case because they cause no harm.
+        */
+
+        ApplyExtraXParamTitle(title, params);
+
+        return;
+    }
+}