Add support for uncached memory for pointers and memory editor

This mainly applies to memory watches and the memory editor. Several other changes are included to account for this change:

1. checkIfPointerIsValid now checks if the pointer passed in is in the cached or uncached memory, and returns a value to specify which. It still returns 0 if the pointer is invalid, so the function return value can still be used like a bool.

2. The upper and lower bounds are no longer applied when working with pointers for memory watches and the memory editor. For memory watches, trying to use an invalid address will result in nothing happening, and the window for selecting the address will not close.

3. The memory editor now allows for scrolling up/down into invalid memory, as the previous restriction on this is much harder to implement when allowing to move to the uncached memory since it is not directly next to the cached memory.

Along with these changes, in main.cpp, backtraceScreenIncrementYPos was modified slightly and moved above jumpOnWater, as they are ordered this way in assembly.h.

Author: Zephiles

ttyd-tools/rel/include/commonfunctions.h

@@ -10,6 +10,13 @@
 
 namespace mod {
 
+enum PointerVerificationType : uint32_t
+{
+    PTR_INVALID = 0,
+    PTR_CACHED,
+    PTR_UNCACHED,
+};
+
 extern "C" {
 
 bool checkButtonCombo(uint32_t combo);
@@ -49,7 +56,7 @@ uint32_t getCurrentPitFloor();
 void setPitFloor(int32_t floor);
 uint32_t getCurrentFPS();
 void clearGSWFsRange(uint32_t lowerBound, uint32_t upperBound);
-bool checkIfPointerIsValid(const void *ptr);
+uint32_t checkIfPointerIsValid(const void *ptr);
 void *getLastPointerFromPath(void *address, int32_t *offset, uint32_t offsetAmount);
 
 }

ttyd-tools/rel/include/memory.h

@@ -14,7 +14,7 @@ void addMemoryWatch(int32_t slot);
 void deleteWatch(int32_t slot);
 void duplicateWatch(int32_t currentSlot, int32_t emptySlot);
 uint32_t adjustWatchValueControls(int32_t slot);
-void adjustWatchTempValueAndBounds(int32_t slot, uint32_t highestDigit, int32_t valueChangedBy);
+void adjustWatchTempValueAndBounds(/* int32_t slot, */ uint32_t highestDigit, int32_t valueChangedBy);
 void *fixBaseAddress(int32_t slot, void *address);
 
 

ttyd-tools/rel/source/commonfunctions.cpp

@@ -392,10 +392,23 @@ void clearGSWFsRange(uint32_t lowerBound, uint32_t upperBound)
     }
 }
 
-bool checkIfPointerIsValid(const void *ptr)
+uint32_t checkIfPointerIsValid(const void *ptr)
 {
     uint32_t ptrRaw = reinterpret_cast<uint32_t>(ptr);
-    return ((ptrRaw >= 0x80000000) && (ptrRaw < 0x81800000));
+    
+    // Cached memory
+    if ((ptrRaw >= 0x80000000) && (ptrRaw < 0x81800000))
+    {
+        return PTR_CACHED;
+    }
+    
+    // Unached memory
+    if ((ptrRaw >= 0xC0000000) && (ptrRaw < 0xC1800000))
+    {
+        return PTR_UNCACHED;
+    }
+    
+    return PTR_INVALID;
 }
 
 void *getLastPointerFromPath(void *address, int32_t *offset, uint32_t offsetAmount)

ttyd-tools/rel/source/main.cpp

@@ -241,33 +241,20 @@ const char *replaceJumpFallAnim(char *jumpFallString)
     return jumpFallString;
 }
 
-void *jumpOnWater(void *ptr)
-{
-    // Allow jumping on water if the Bridge Skip display is active
-    if (Displays[BRIDGE_SKIP])
-    {
-        return nullptr;
-    }
-    else
-    {
-        // Return the original value
-        return ptr;
-    }
-}
-
 int32_t backtraceScreenIncrementYPos()
 {
+    constexpr int32_t kPosYIncrementAmount = 50;
     static int16_t IncrementCount = 0;
     int32_t tempIncrementCount = IncrementCount;
 
-    int32_t TextPosY = tempIncrementCount + 50;
+    int32_t TextPosY = tempIncrementCount + kPosYIncrementAmount;
     tempIncrementCount--;
 
     if (tempIncrementCount < -960)
     {
         // Simulate incrementing exactly once to match the US/PAL code
         IncrementCount = -1;
-        return 50;
+        return kPosYIncrementAmount;
     }
     else
     {
@@ -276,6 +263,20 @@ int32_t backtraceScreenIncrementYPos()
     }
 }
 
+void *jumpOnWater(void *ptr)
+{
+    // Allow jumping on water if the Bridge Skip display is active
+    if (Displays[BRIDGE_SKIP])
+    {
+        return nullptr;
+    }
+    else
+    {
+        // Return the original value
+        return ptr;
+    }
+}
+
 void displayTitleScreenAndFileSelectScreenInfo()
 {
     if (checkForSpecificSeq(ttyd::seqdrv::SeqIndex::kTitle))

ttyd-tools/rel/source/memory.cpp

@@ -82,7 +82,7 @@ const char *getAddressStringFromOffsets(int32_t slot, uint32_t maxOffset)
         return "???";
     }
 
-    // Make sure the address being read does not exceed 0x817FFFFF
+    // Make sure the address being read does not exceed 0x817FFFFF/0xC17FFFFF
     Address = reinterpret_cast<uint32_t>(fixBaseAddress(
         slot, reinterpret_cast<void *>(Address)));
 
@@ -107,7 +107,7 @@ const char *getValueString(int32_t slot)
         return "???";
     }
 
-    // Make sure the address being read does not exceed 0x817FFFFF
+    // Make sure the address being read does not exceed 0x817FFFFF/0xC17FFFFF
     Address = reinterpret_cast<uint32_t>(fixBaseAddress(
         slot, reinterpret_cast<void *>(Address)));
 
@@ -433,7 +433,7 @@ uint32_t adjustWatchValueControls(int32_t slot)
                         IncrementAmount = -1;
                     }
 
-                    adjustWatchTempValueAndBounds(slot, HighestDigit, IncrementAmount);
+                    adjustWatchTempValueAndBounds(HighestDigit, IncrementAmount);
                     MemoryWatchAdjustableValueMenu.WaitFramesToPerformIncrement = 0;
                     return Button;
                 }
@@ -498,15 +498,15 @@ uint32_t adjustWatchValueControls(int32_t slot)
         case DPADDOWN:
         {
             // Decrement the current value for the current slot
-            adjustWatchTempValueAndBounds(slot, HighestDigit, -1);
+            adjustWatchTempValueAndBounds(HighestDigit, -1);
 
             MenuVar.FrameCounter = 1;
             return Button;
         }
         case DPADUP:
         {
             // Increment the current value for the current slot
-            adjustWatchTempValueAndBounds(slot, HighestDigit, 1);
+            adjustWatchTempValueAndBounds(HighestDigit, 1);
 
             MenuVar.FrameCounter = 1;
             return Button;
@@ -522,14 +522,22 @@ uint32_t adjustWatchValueControls(int32_t slot)
                         case 0:
                         {
                             // Modifying the address
-                            // Make sure the address being read does not exceed 0x817FFFFF
-                            MemoryWatch[slot].Address = reinterpret_cast<uint32_t>(
-                                fixBaseAddress(slot, reinterpret_cast<void *>(MenuVar.MenuSecondaryValueUnsigned)));
-                            
-                            MenuVar.MenuSelectionStates = 0;
+                            // Make sure the address is valid
+                            uint32_t tempMenuSecondaryValueUnsigned = MenuVar.MenuSecondaryValueUnsigned;
+                            if (checkIfPointerIsValid(reinterpret_cast<void *>(tempMenuSecondaryValueUnsigned)))
+                            {
+                                MemoryWatch[slot].Address = tempMenuSecondaryValueUnsigned;
+                                
+                                MenuVar.MenuSelectionStates = 0;
 
-                            MenuVar.FrameCounter = 1;
-                            return Button;
+                                MenuVar.FrameCounter = 1;
+                                return Button;
+                            }
+                            else
+                            {
+                                // Tried to use an invalid address, so do nothing
+                                return 0;
+                            }
                         }
                         default:
                         {
@@ -584,7 +592,7 @@ uint32_t adjustWatchValueControls(int32_t slot)
     }
 }
 
-void adjustWatchTempValueAndBounds(int32_t slot, uint32_t highestDigit, int32_t valueChangedBy)
+void adjustWatchTempValueAndBounds(uint32_t highestDigit, int32_t valueChangedBy)
 {
     for (uint32_t i = 0; i < (highestDigit - MenuVar.SecondaryMenuOption - 1); i++)
     {
@@ -598,8 +606,8 @@ void adjustWatchTempValueAndBounds(int32_t slot, uint32_t highestDigit, int32_t
     {
         case MEMORY_WATCH_CHANGE_ADDRESS:
         {
-            uint32_t UpperBoundUnsigned;
-            uint32_t LowerBoundUnsigned;
+            // uint32_t UpperBoundUnsigned;
+            // uint32_t LowerBoundUnsigned;
             int32_t UpperBoundSigned;
             int32_t LowerBoundSigned;
 
@@ -608,22 +616,7 @@ void adjustWatchTempValueAndBounds(int32_t slot, uint32_t highestDigit, int32_t
                 case 0:
                 {
                     // Modifying the address
-                    // Make sure the upper bound does not exceed 0x817FFFFF
-                    UpperBoundUnsigned = reinterpret_cast<uint32_t>(
-                        fixBaseAddress(slot, reinterpret_cast<void *>(0x817FFFFF)));
-                    
-                    LowerBoundUnsigned = 0x80000000;
-                    
-                    if (tempMenuSecondaryValueUnsigned > UpperBoundUnsigned)
-                    {
-                        // Loop to the beginning
-                        MenuVar.MenuSecondaryValueUnsigned = LowerBoundUnsigned;
-                    }
-                    else if (tempMenuSecondaryValueUnsigned < LowerBoundUnsigned)
-                    {
-                        // Loop to the end
-                        MenuVar.MenuSecondaryValueUnsigned = UpperBoundUnsigned;
-                    }
+                    // Nothing needs to be done for this
                     break;
                 }
                 default:
@@ -690,9 +683,21 @@ void *fixBaseAddress(int32_t slot, void *address)
         }
     }
 
-    // Make sure the address does not exceed 0x817FFFFF
+    // Make sure the address does not exceed 0x817FFFFF/0xC17FFFFF
     uint32_t tempAddress = reinterpret_cast<uint32_t>(address);
-    while ((tempAddress + CurrentTypeSize - 1) >= 0x81800000)
+    
+    // Arbitrary check for cached memory
+    uint32_t AddressCap;
+    if (tempAddress < 0x90000000)
+    {
+        AddressCap = 0x81800000;
+    }
+    else
+    {
+        AddressCap = 0xC1800000;
+    }
+    
+    while ((tempAddress + CurrentTypeSize - 1) >= AddressCap)
     {
         tempAddress--;
     }
@@ -1271,13 +1276,9 @@ uint32_t memoryEditorButtonControls()
 
                 if (RowCheck)
                 {
-                    // Only move down if there's at least one valid byte under the last row
-                    if (checkIfPointerIsValid(CurrentAddress + EDITOR_MAX_NUM_BYTES_DISPLAYED))
-                    {
-                        // Move down one row
-                        // Don't set CurrentEditorMenuOption, as it's already correct
-                        MemoryEditor.CurrentAddress = CurrentAddress + EDITOR_BYTES_PER_ROW;
-                    }
+                    // Move down one row
+                    // Don't set CurrentEditorMenuOption, as it's already correct
+                    MemoryEditor.CurrentAddress = CurrentAddress + EDITOR_BYTES_PER_ROW;
                 }
                 else
                 {
@@ -1340,13 +1341,9 @@ uint32_t memoryEditorButtonControls()
                 // Check to see if moving up goes to the previous row
                 if (CurrentEditorMenuOption < 0)
                 {
-                    // Only move up if there's at least one valid byte above the first row
-                    if (checkIfPointerIsValid(CurrentAddress - 0x1))
-                    {
-                        // Move up one row
-                        // Don't set CurrentEditorMenuOption, as it's already correct
-                        MemoryEditor.CurrentAddress = CurrentAddress - EDITOR_BYTES_PER_ROW;
-                    }
+                    // Move up one row
+                    // Don't set CurrentEditorMenuOption, as it's already correct
+                    MemoryEditor.CurrentAddress = CurrentAddress - EDITOR_BYTES_PER_ROW;
                 }
                 else
                 {
@@ -1450,6 +1447,14 @@ uint32_t memoryEditorButtonControls()
                     uint32_t Start = reinterpret_cast<uint32_t>(tempAddress);
                     uint32_t End = Start + NumBytesBeingEdited;
 
+                    // Arbitrary check for cached memory
+                    if (checkIfPointerIsValid(tempAddress) == PTR_UNCACHED)
+                    {
+                        // Only need to clear cached memory, so adjust the start and end to be in cached memory
+                        Start -= 0x40000000;
+                        End -= 0x40000000;
+                    }
+                    
                     if (Start < 0x80000000)
                     {
                         Start = 0x80000000;

ttyd-tools/rel/source/menufunctions.cpp

@@ -739,8 +739,8 @@ void getUpperAndLowerBounds(int32_t arrayOut[2], uint32_t currentMenu)
         {
             if (MemoryEditor.CurrentEditorMenuOption == EDITOR_HEADER_CHANGE_ADDRESS)
             {
-                LowerBound = 0x80000000;
-                UpperBound = 0x817FFFFF;
+                // LowerBound = 0;
+                UpperBound = 0xFFFFFFFF;
             }
             else // Changing the amount of bytes to modify
             {
@@ -1776,7 +1776,7 @@ uint32_t memoryAddressTypeButtonControls()
             uint32_t tempMenuSelectedOption = MenuVar.MenuSelectedOption;
             MemoryWatch[tempMenuSelectedOption].Type = tempSecondaryMenuOption;
 
-            // Make sure the address being read does not exceed 0x817FFFFF
+            // Make sure the address being read does not exceed 0x817FFFFF/0xC17FFFFF
             MemoryWatch[tempMenuSelectedOption].Address = reinterpret_cast<uint32_t>(
                 fixBaseAddress(tempMenuSelectedOption, reinterpret_cast<void *>(
                     MemoryWatch[tempMenuSelectedOption].Address)));
@@ -2267,7 +2267,7 @@ void adjustMenuItemBoundsMain(int32_t valueChangedBy, int32_t lowerBound, int32_
     }
 }
 
-void adjustMenuItemBoundsMainUnsigned(int32_t valueChangedBy, uint32_t lowerBound, uint32_t upperBound)
+/* void adjustMenuItemBoundsMainUnsigned(int32_t valueChangedBy, uint32_t lowerBound, uint32_t upperBound)
 {
     int64_t tempMenuSecondaryValue = MenuVar.MenuSecondaryValueUnsigned + valueChangedBy;
     MenuVar.MenuSecondaryValueUnsigned = static_cast<uint32_t>(tempMenuSecondaryValue);
@@ -2307,7 +2307,7 @@ void adjustMenuItemBoundsMainUnsigned(int32_t valueChangedBy, uint32_t lowerBoun
             MenuVar.MenuSecondaryValueUnsigned = upperBound;
         }
     }
-}
+} */
 
 void adjustMenuItemBounds(int32_t valueChangedBy, uint32_t currentMenu)
 {
@@ -2368,14 +2368,8 @@ void adjustMenuItemBounds(int32_t valueChangedBy, uint32_t currentMenu)
             if ((currentMenu == MEMORY_EDITOR_MENU) && 
                 (MemoryEditor.CurrentEditorMenuOption == EDITOR_HEADER_CHANGE_ADDRESS))
             {
-                // Handle everything as unsigned
-                int32_t UpperAndLowerBounds[2];
-                getUpperAndLowerBounds(UpperAndLowerBounds, currentMenu);
-                
-                uint32_t LowerBound = static_cast<uint32_t>(UpperAndLowerBounds[0]);
-                uint32_t UpperBound = static_cast<uint32_t>(UpperAndLowerBounds[1]);
-                
-                adjustMenuItemBoundsMainUnsigned(valueChangedBy, LowerBound, UpperBound);
+                // No adjustments are needed, so write the new value immediately and return
+                MenuVar.MenuSecondaryValueUnsigned += valueChangedBy;
                 return;
             }
             break;
@@ -2395,8 +2389,7 @@ void adjustMenuItemBounds(int32_t valueChangedBy, uint32_t currentMenu)
     adjustMenuItemBoundsMain(valueChangedBy, LowerBound, UpperBound);
 }
 
-void adjustAddByIdValue(int32_t value, uint32_t currentMenu, 
-    bool handleAsHex, bool handleAsUnsigned)
+void adjustAddByIdValue(int32_t value, uint32_t currentMenu, bool handleAsHex, bool handleAsUnsigned)
 {
     int32_t multiplyAmount;
     if (handleAsHex)