Add game quirks for unknown BP/CP/XF commands

Source/Core/Core/DolphinAnalytics.cpp

@@ -133,7 +133,8 @@ void DolphinAnalytics::ReportGameStart()
 }
 
 // Keep in sync with enum class GameQuirk definition.
-constexpr std::array<const char*, 14> GAME_QUIRKS_NAMES{"icache-matters",
+constexpr std::array<const char*, 18> GAME_QUIRKS_NAMES{
+    "icache-matters",
     "directly-reads-wiimote-input",
     "uses-DVDLowStopLaser",
     "uses-DVDLowOffset",
@@ -146,7 +147,12 @@ constexpr std::array<const char*, 14> GAME_QUIRKS_NAMES{"icache-matters",
     "mismatched-gpu-texgens-between-xf-and-bp",
     "mismatched-gpu-colors-between-xf-and-bp",
     "uses-uncommon-wd-mode",
-                                                        "uses-wd-unimplemented-ioctl"};
+    "uses-wd-unimplemented-ioctl",
+    "uses-unknown-bp-command",
+    "uses-unknown-cp-command",
+    "uses-unknown-xf-command",
+    "uses-maybe-invalid-cp-command",
+};
 static_assert(GAME_QUIRKS_NAMES.size() == static_cast<u32>(GameQuirk::COUNT),
               "Game quirks names and enum definition are out of sync.");
 

Source/Core/Core/DolphinAnalytics.h

@@ -61,6 +61,15 @@ enum class GameQuirk
 
   USES_WD_UNIMPLEMENTED_IOCTL,
 
+  // Some games use invalid/unknown graphics commands (see e.g. bug 10931).
+  // These are different from unknown opcodes: it is known that a BP/CP/XF command is being used,
+  // but the command itself is not understood.
+  USES_UNKNOWN_BP_COMMAND,
+  USES_UNKNOWN_CP_COMMAND,
+  USES_UNKNOWN_XF_COMMAND,
+  // YAGCD and Dolphin's implementation disagree about what is valid in some cases
+  USES_MAYBE_INVALID_CP_COMMAND,
+
   COUNT,
 };
 

Source/Core/VideoCommon/BPStructs.cpp

@@ -12,8 +12,10 @@
 
 #include "Common/CommonTypes.h"
 #include "Common/Logging/Log.h"
+
 #include "Core/ConfigManager.h"
 #include "Core/CoreTiming.h"
+#include "Core/DolphinAnalytics.h"
 #include "Core/FifoPlayer/FifoPlayer.h"
 #include "Core/FifoPlayer/FifoRecorder.h"
 #include "Core/HW/Memmap.h"
@@ -704,6 +706,7 @@ static void BPWritten(const BPCmd& bp)
     break;
   }
 
+  DolphinAnalytics::Instance().ReportGameQuirk(GameQuirk::USES_UNKNOWN_BP_COMMAND);
   WARN_LOG_FMT(VIDEO, "Unknown BP opcode: address = {:#010x} value = {:#010x}", bp.address,
                bp.newvalue);
 }

Source/Core/VideoCommon/VertexLoaderManager.cpp

@@ -16,6 +16,8 @@
 #include "Common/Assert.h"
 #include "Common/CommonTypes.h"
 #include "Common/Logging/Log.h"
+
+#include "Core/DolphinAnalytics.h"
 #include "Core/HW/Memmap.h"
 
 #include "VideoCommon/BPMemory.h"
@@ -322,22 +324,34 @@ void LoadCPReg(u32 sub_cmd, u32 value, bool is_preprocess)
   switch (sub_cmd & CP_COMMAND_MASK)
   {
   case MATINDEX_A:
+    if (sub_cmd != MATINDEX_A)
+      DolphinAnalytics::Instance().ReportGameQuirk(GameQuirk::USES_MAYBE_INVALID_CP_COMMAND);
+
     if (update_global_state)
       VertexShaderManager::SetTexMatrixChangedA(value);
     break;
 
   case MATINDEX_B:
+    if (sub_cmd != MATINDEX_B)
+      DolphinAnalytics::Instance().ReportGameQuirk(GameQuirk::USES_MAYBE_INVALID_CP_COMMAND);
+
     if (update_global_state)
       VertexShaderManager::SetTexMatrixChangedB(value);
     break;
 
   case VCD_LO:
+    if (sub_cmd != VCD_LO)  // Stricter than YAGCD
+      DolphinAnalytics::Instance().ReportGameQuirk(GameQuirk::USES_MAYBE_INVALID_CP_COMMAND);
+
     state->vtx_desc.low.Hex = value;
     state->attr_dirty = BitSet32::AllTrue(CP_NUM_VAT_REG);
     state->bases_dirty = true;
     break;
 
   case VCD_HI:
+    if (sub_cmd != VCD_HI)  // Stricter than YAGCD
+      DolphinAnalytics::Instance().ReportGameQuirk(GameQuirk::USES_MAYBE_INVALID_CP_COMMAND);
+
     state->vtx_desc.high.Hex = value;
     state->attr_dirty = BitSet32::AllTrue(CP_NUM_VAT_REG);
     state->bases_dirty = true;
@@ -345,21 +359,30 @@ void LoadCPReg(u32 sub_cmd, u32 value, bool is_preprocess)
 
   case CP_VAT_REG_A:
     if ((sub_cmd - CP_VAT_REG_A) >= CP_NUM_VAT_REG)
+    {
+      DolphinAnalytics::Instance().ReportGameQuirk(GameQuirk::USES_MAYBE_INVALID_CP_COMMAND);
       WARN_LOG_FMT(VIDEO, "CP_VAT_REG_A: Invalid VAT {}", sub_cmd - CP_VAT_REG_A);
+    }
     state->vtx_attr[sub_cmd & CP_VAT_MASK].g0.Hex = value;
     state->attr_dirty[sub_cmd & CP_VAT_MASK] = true;
     break;
 
   case CP_VAT_REG_B:
     if ((sub_cmd - CP_VAT_REG_B) >= CP_NUM_VAT_REG)
+    {
+      DolphinAnalytics::Instance().ReportGameQuirk(GameQuirk::USES_MAYBE_INVALID_CP_COMMAND);
       WARN_LOG_FMT(VIDEO, "CP_VAT_REG_B: Invalid VAT {}", sub_cmd - CP_VAT_REG_B);
+    }
     state->vtx_attr[sub_cmd & CP_VAT_MASK].g1.Hex = value;
     state->attr_dirty[sub_cmd & CP_VAT_MASK] = true;
     break;
 
   case CP_VAT_REG_C:
     if ((sub_cmd - CP_VAT_REG_C) >= CP_NUM_VAT_REG)
+    {
+      DolphinAnalytics::Instance().ReportGameQuirk(GameQuirk::USES_MAYBE_INVALID_CP_COMMAND);
       WARN_LOG_FMT(VIDEO, "CP_VAT_REG_C: Invalid VAT {}", sub_cmd - CP_VAT_REG_C);
+    }
     state->vtx_attr[sub_cmd & CP_VAT_MASK].g2.Hex = value;
     state->attr_dirty[sub_cmd & CP_VAT_MASK] = true;
     break;
@@ -376,6 +399,7 @@ void LoadCPReg(u32 sub_cmd, u32 value, bool is_preprocess)
     break;
 
   default:
+    DolphinAnalytics::Instance().ReportGameQuirk(GameQuirk::USES_UNKNOWN_CP_COMMAND);
     WARN_LOG_FMT(VIDEO, "Unknown CP register {:02x} set to {:08x}", sub_cmd, value);
   }
 }

Source/Core/VideoCommon/XFStructs.cpp

@@ -9,6 +9,7 @@
 #include "Common/Logging/Log.h"
 #include "Common/Swap.h"
 
+#include "Core/DolphinAnalytics.h"
 #include "Core/HW/Memmap.h"
 
 #include "VideoCommon/CPMemory.h"
@@ -182,6 +183,7 @@ static void XFRegWritten(int transferSize, u32 baseAddress, DataReader src)
     case 0x104d:
     case 0x104e:
     case 0x104f:
+      DolphinAnalytics::Instance().ReportGameQuirk(GameQuirk::USES_UNKNOWN_XF_COMMAND);
       DEBUG_LOG_FMT(VIDEO, "Possible Normal Mtx XF reg?: {:x}={:x}", address, newValue);
       break;
 
@@ -192,6 +194,7 @@ static void XFRegWritten(int transferSize, u32 baseAddress, DataReader src)
     case 0x1017:
 
     default:
+      DolphinAnalytics::Instance().ReportGameQuirk(GameQuirk::USES_UNKNOWN_XF_COMMAND);
       if (newValue != 0)  // Ignore writes of zero.
         WARN_LOG_FMT(VIDEO, "Unknown XF Reg: {:x}={:x}", address, newValue);
       break;
@@ -211,6 +214,7 @@ void LoadXFReg(u32 transferSize, u32 baseAddress, DataReader src)
   if (baseAddress + transferSize > XFMEM_REGISTERS_END)
   {
     WARN_LOG_FMT(VIDEO, "XF load exceeds address space: {:x} {} bytes", baseAddress, transferSize);
+    DolphinAnalytics::Instance().ReportGameQuirk(GameQuirk::USES_UNKNOWN_XF_COMMAND);
 
     if (baseAddress >= XFMEM_REGISTERS_END)
       transferSize = 0;