Document src/save.c

common_syms/save.txt

@@ -1,12 +1,12 @@
-gFirstSaveSector
+gLastWrittenSector
-gPrevSaveCounter
+gLastSaveCounter
 gLastKnownGoodSector
 gDamagedSaveSectors
 gSaveCounter
-gFastSaveSection
+gSaveDataBufferPtr
-gUnknown_3005398
+gIncrementalSectorId
 gSaveUnusedVar
 gSaveFileStatus
 gGameContinueCallback
-gRamSaveSectionLocations
+gRamSaveSectorLocations
-gSaveSucceeded
+gSaveAttemptStatus

include/save.h

@@ -3,7 +3,28 @@
 
 #include "global.h"
 
-#define NUM_SECTORS 32 // defined in agb_flash but not in a header
+// Each 4 KiB flash sector contains 3968 bytes of actual data followed by a 128 byte footer.
+// Only 12 bytes of the footer are used.
+#define SECTOR_DATA_SIZE 3968
+#define SECTOR_FOOTER_SIZE 128
+#define SECTOR_SIZE (SECTOR_DATA_SIZE + SECTOR_FOOTER_SIZE)
+
+#define FILE_SIGNATURE 0x08012025  // signature value to determine if a sector is in use
+
+#define SPECIAL_SECTOR_SENTINEL 0xB39D
+
+#define SECTOR_ID_SAVEBLOCK2          0
+#define SECTOR_ID_SAVEBLOCK1_START    1
+#define SECTOR_ID_SAVEBLOCK1_END      4
+#define SECTOR_ID_PKMN_STORAGE_START  5
+#define SECTOR_ID_PKMN_STORAGE_END   13
+#define NUM_SECTORS_PER_SLOT         14
+// Save Slot 1: 0-13;  Save Slot 2: 14-27
+#define SECTOR_ID_HOF_1              28
+#define SECTOR_ID_HOF_2              29
+#define SECTOR_ID_TRAINER_TOWER_1    30
+#define SECTOR_ID_TRAINER_TOWER_2    31
+#define SECTORS_COUNT                32
 
 #define SAVE_STATUS_EMPTY    0
 #define SAVE_STATUS_OK       1
@@ -21,45 +42,33 @@ enum
     SAVE_HALL_OF_FAME_ERASE_BEFORE, // unused
 };
 
-struct SaveBlockChunk
+// A save sector location holds a pointer to the data for a particular sector
+// and the size of that data. Size cannot be greater than SECTOR_DATA_SIZE.
+struct SaveSectorLocation
 {
     u8 *data;
     u16 size;
 };
 
-struct SaveSection
+struct SaveSector
 {
-    u8 data[0xFF4];
+    u8 data[SECTOR_DATA_SIZE];
+    u8 unused[SECTOR_FOOTER_SIZE - 12]; // Unused portion of the footer
     u16 id;
     u16 checksum;
     u32 signature;
     u32 counter;
 }; // size is 0x1000
 
-// headless save section?
+#define SECTOR_SIGNATURE_OFFSET offsetof(struct SaveSector, signature)
-struct UnkSaveSection
+#define SECTOR_COUNTER_OFFSET   offsetof(struct SaveSector, counter)
-{
-    u8 data[0xFF4];
-    u32 signature;
-}; // size is 0xFF8
 
-struct SaveSectionOffsets
+// Special sector id value for certain save functions
-{
+// to indicate that all sectors should be used
-    u16 toAdd;
+// instead of a specific sector.
-    u16 size;
+#define FULL_SAVE_SLOT 0xFFFF
-};
 
-// Emerald changes this definition to be the sectors per slot.
+// operations for SetDamagedSectorBits
-#define NUM_SECTORS_PER_SAVE_SLOT 14  // Number of sectors occupied by a save slot
-
-#define UNKNOWN_CHECK_VALUE 0x8012025
-
-#define SECTOR_SAVE1(n)  (n)
-#define SECTOR_SAVE2(n)  ((n) + NUM_SECTORS_PER_SAVE_SLOT)
-#define SECTOR_HOF(n)    ((n) + 2 * NUM_SECTORS_PER_SAVE_SLOT)
-#define SECTOR_TTOWER(n) ((n) + 2 * NUM_SECTORS_PER_SAVE_SLOT + 2)
-
-// SetSectorDamagedStatus states
 enum
 {
     ENABLE,
@@ -67,53 +76,27 @@ enum
     CHECK // unused
 };
 
-extern u16 gFirstSaveSector;
-extern u32 gPrevSaveCounter;
-extern u16 gLastKnownGoodSector;
 extern u32 gDamagedSaveSectors;
-extern u32 gSaveCounter;
+extern struct SaveSector *gSaveDataBufferPtr; // the pointer is in fast IWRAM but points to the slower EWRAM.
-extern struct SaveSection *gFastSaveSection; // the pointer is in fast IWRAM but may sometimes point to the slower EWRAM.
-extern u16 gUnknown_3005398;
-extern u16 gSaveUnusedVar;
 extern u16 gSaveFileStatus;
 extern void (*gGameContinueCallback)(void);
-extern struct SaveBlockChunk gRamSaveSectionLocations[0xE];
+extern u16 gSaveAttemptStatus;
-extern u16 gSaveSucceeded;
 
-extern struct SaveSection gSaveDataBuffer;
+extern struct SaveSector gSaveDataBuffer;
 
 void ClearSaveData(void);
 void Save_ResetSaveCounters(void);
-bool32 SetSectorDamagedStatus(u8 op, u8 bit);
-u8 save_write_to_flash(u16 a1, const struct SaveBlockChunk *location);
-u8 HandleWriteSector(u16 a1, const struct SaveBlockChunk *location);
-u8 HandleWriteSectorNBytes(u8 sector, u8 *data, u16 size);
-u8 TryWriteSector(u8 sector, u8 *data);
-u32 RestoreSaveBackupVarsAndIncrement(const struct SaveBlockChunk *location);
-u32 RestoreSaveBackupVars(const struct SaveBlockChunk *location);
-u8 sub_80D9AA4(u16 a1, const struct SaveBlockChunk *location);
-u8 sub_80D9B04(u16 a1, const struct SaveBlockChunk *location);
-u8 ClearSaveData_2(u16 a1, const struct SaveBlockChunk *location);
-u8 sav12_xor_get(u16 a1, const struct SaveBlockChunk *location);
-u8 sub_80D9D88(u16 a1, const struct SaveBlockChunk *location);
-u8 sub_80D9E14(u16 a1, const struct SaveBlockChunk *location);
-u8 sub_80D9E54(u16 a1, const struct SaveBlockChunk *location);
-u8 GetSaveValidStatus(const struct SaveBlockChunk *location);
-u8 sub_80DA120(u8 a1, u8 *data, u16 size);
-u8 DoReadFlashWholeSection(u8 sector, struct SaveSection *section);
-u16 CalculateChecksum(void *data, u16 size);
-void UpdateSaveAddresses(void);
 u8 HandleSavingData(u8 saveType);
 u8 TrySavingData(u8 saveType);
-u8 SaveGame_AfterLinkTrade(void);
+bool8 LinkFullSave_Init(void);
-bool8 AfterLinkTradeSaveFailed(void);
+bool8 LinkFullSave_WriteSector(void);
-u8 ClearSaveAfterLinkTradeSaveFailure(void);
+bool8 LinkFullSave_ReplaceLastSector(void);
-u8 sub_80DA434(void);
+bool8 LinkFullSave_SetLastSectorSignature(void);
-u8 sub_80DA45C(void);
+bool8 WriteSaveBlock2(void);
-bool8 sub_80DA4A0(void);
+bool8 WriteSaveBlock1Sector(void);
-u8 Save_LoadGameData(u8 saveType);
+u8 LoadGameSave(u8 saveType);
-u32 TryCopySpecialSaveSection(u8 sector, u8 *dst);
+u32 TryReadSpecialSaveSector(u8 sector, u8 *dst);
-u32 TryWriteSpecialSaveSection(u8 sector, u8 *src);
+u32 TryWriteSpecialSaveSector(u8 sector, u8 *src);
-void Task_LinkSave(u8 taskId);
+void Task_LinkFullSave(u8 taskId);
 
 #endif // GUARD_SAVE_H

src/berry_crush.c

@@ -2224,10 +2224,10 @@ static u32 Cmd_SaveGame(struct BerryCrushGame * game, u8 *args)
         DrawDialogueFrame(0, FALSE);
         AddTextPrinterParameterized2(0, FONT_2, gText_SavingDontTurnOffThePower2, 0, NULL, TEXT_COLOR_DARK_GRAY, TEXT_COLOR_WHITE, TEXT_COLOR_LIGHT_GRAY);
         CopyWindowToVram(0, COPYWIN_FULL);
-        CreateTask(Task_LinkSave, 0);
+        CreateTask(Task_LinkFullSave, 0);
         break;
     case 3:
-        if (FuncIsActiveTask(Task_LinkSave))
+        if (FuncIsActiveTask(Task_LinkFullSave))
             return 0;
         break;
     case 4:

src/cereader_tool.c

@@ -47,11 +47,11 @@ static bool32 CEReaderTool_SaveTrainerTower_r(struct EReaderTrainerTowerSet * tt
     memset(buffer, 0, 0x1000);
     memcpy(buffer, ttdata, SEC30_SIZE);
     buffer[1] = sub_815D654();
-    if (TryWriteSpecialSaveSection(SECTOR_TTOWER(0), buffer) != TRUE)
+    if (TryWriteSpecialSaveSector(SECTOR_ID_TRAINER_TOWER_1, buffer) != TRUE)
         return FALSE;
     memset(buffer, 0, 0x1000);
     memcpy(buffer, (u8 *)ttdata + SEC30_SIZE, SEC31_SIZE);
-    if (TryWriteSpecialSaveSection(SECTOR_TTOWER(1), buffer) != TRUE)
+    if (TryWriteSpecialSaveSector(SECTOR_ID_TRAINER_TOWER_2, buffer) != TRUE)
         return FALSE;
     return TRUE;
 }
@@ -66,11 +66,11 @@ bool32 CEReaderTool_SaveTrainerTower(struct EReaderTrainerTowerSet * ttdata)
 
 static bool32 CEReaderTool_LoadTrainerTower_r(struct EReaderTrainerTowerSet * ttdata, void *buffer)
 {
-    if (TryCopySpecialSaveSection(SECTOR_TTOWER(0), buffer) != 1)
+    if (TryReadSpecialSaveSector(SECTOR_ID_TRAINER_TOWER_1, buffer) != 1)
         return FALSE;
     memcpy(ttdata + 0x000, buffer, SEC30_SIZE);
 
-    if (TryCopySpecialSaveSection(SECTOR_TTOWER(1), buffer) != 1)
+    if (TryReadSpecialSaveSector(SECTOR_ID_TRAINER_TOWER_2, buffer) != 1)
         return FALSE;
     memcpy((u8 *)ttdata + SEC30_SIZE, buffer, SEC31_SIZE);
 

src/dodrio_berry_picking_2.c

@@ -1431,12 +1431,12 @@ static void sub_8155A78(void)
     case 2:
         if (!IsDma3ManagerBusyWithBgCopy())
         {
-            CreateTask(Task_LinkSave, 0);
+            CreateTask(Task_LinkFullSave, 0);
             gUnknown_203F440->state++;
         }
         break;
     case 3:
-        if (!FuncIsActiveTask(Task_LinkSave))
+        if (!FuncIsActiveTask(Task_LinkFullSave))
             gUnknown_203F440->state++;
         break;
     default:

src/hall_of_fame.c

@@ -429,7 +429,7 @@ static void Task_Hof_InitTeamSaveData(u8 taskId)
     }
     else
     {
-        if (Save_LoadGameData(SAVE_HALL_OF_FAME) != TRUE)
+        if (LoadGameSave(SAVE_HALL_OF_FAME) != SAVE_STATUS_OK)
             memset(gDecompressionBuffer, 0, 0x2000);
     }
 
@@ -759,7 +759,7 @@ static void Task_HofPC_CopySaveData(u8 taskId)
     struct HallofFameTeam* savedTeams;
 
     CreateTopBarWindowLoadPalette(0, 30, 0, 0x0C, 0x226);
-    if (Save_LoadGameData(SAVE_HALL_OF_FAME) != SAVE_STATUS_OK)
+    if (LoadGameSave(SAVE_HALL_OF_FAME) != SAVE_STATUS_OK)
     {
         gTasks[taskId].func = Task_HofPC_PrintDataIsCorrupted;
     }

src/intro.c

@@ -872,7 +872,7 @@ void c2_copyright_1(void)
     {
         ResetMenuAndMonGlobals();
         Save_ResetSaveCounters();
-        Save_LoadGameData(SAVE_NORMAL);
+        LoadGameSave(SAVE_NORMAL);
         if (gSaveFileStatus == SAVE_STATUS_EMPTY || gSaveFileStatus == SAVE_STATUS_INVALID)
             Sav2_ClearSetDefault();
         SetPokemonCryStereo(gSaveBlock2Ptr->optionsSound);

src/pokemon_jump.c

@@ -1620,12 +1620,12 @@ static bool32 SavePokeJump(void)
     case 2:
         if (AreLinkQueuesEmpty())
         {
-            CreateTask(Task_LinkSave, 6);
+            CreateTask(Task_LinkFullSave, 6);
             sPokemonJump->mainState++;
         }
         break;
     case 3:
-        if (!FuncIsActiveTask(Task_LinkSave))
+        if (!FuncIsActiveTask(Task_LinkFullSave))
         {
             ClearMessageWindow();
             sPokemonJump->mainState++;

src/quest_log.c

@@ -809,7 +809,7 @@ static void QuestLog_StartFinalScene(void)
 {
     ResetSpecialVars();
     Save_ResetSaveCounters();
-    Save_LoadGameData(SAVE_NORMAL);
+    LoadGameSave(SAVE_NORMAL);
     SetMainCallback2(CB2_EnterFieldFromQuestLog);
     gFieldCallback2 = FieldCB2_FinalScene;
     FreeAllWindowBuffers();

src/reset_save_heap.c

@@ -18,7 +18,7 @@ void ResetSaveHeap(void)
     SetSaveBlocksPointers();
     ResetMenuAndMonGlobals();
     Save_ResetSaveCounters();
-    Save_LoadGameData(SAVE_NORMAL);
+    LoadGameSave(SAVE_NORMAL);
     if (gSaveFileStatus == SAVE_STATUS_EMPTY || gSaveFileStatus == SAVE_STATUS_INVALID)
         Sav2_ClearSetDefault();
     SetPokemonCryStereo(gSaveBlock2Ptr->optionsSound);

src/save_failed_screen.c

@@ -74,12 +74,12 @@ bool32 RunSaveFailedScreen(void)
     case 5:
         if (TryWipeDamagedSectors() == TRUE)
         {
-            gSaveSucceeded = SAVE_STATUS_OK;
+            gSaveAttemptStatus = SAVE_STATUS_OK;
             PrintTextOnSaveFailedScreen(gText_SaveFailedScreen_SaveCompleted);
         }
         else
         {
-            gSaveSucceeded = SAVE_STATUS_ERROR;
+            gSaveAttemptStatus = SAVE_STATUS_ERROR;
             PrintTextOnSaveFailedScreen(gText_SaveFailedScreen_BackupMemoryDamaged);
         }
         sSaveFailedScreenState = 6;

src/start_menu.c

@@ -798,7 +798,7 @@ static u8 SaveDialogCB_DoSave(void)
 
 static u8 SaveDialogCB_PrintSaveResult(void)
 {
-    if (gSaveSucceeded == TRUE)
+    if (gSaveAttemptStatus == SAVE_STATUS_OK)
         PrintSaveTextWithFollowupFunc(gText_PlayerSavedTheGame, SaveDialogCB_WaitPrintSuccessAndPlaySE);
     else
         PrintSaveTextWithFollowupFunc(gText_SaveError_PleaseExchangeBackupMemory, SaveDialogCB_WaitPrintErrorAndPlaySE);
@@ -921,11 +921,11 @@ static void task50_after_link_battle_save(u8 taskId)
             break;
         case 1:
             SetContinueGameWarpStatusToDynamicWarp();
-            sub_80DA45C();
+            WriteSaveBlock2();
             data[0] = 2;
             break;
         case 2:
-            if (sub_80DA4A0())
+            if (WriteSaveBlock1Sector())
             {
                 ClearContinueGameWarpStatus2();
                 data[0] = 3;
@@ -941,11 +941,11 @@ static void task50_after_link_battle_save(u8 taskId)
             DestroyTask(taskId);
             break;
         case 5:
-            CreateTask(Task_LinkSave, 5);
+            CreateTask(Task_LinkFullSave, 5);
             data[0] = 6;
             break;
         case 6:
-            if (!FuncIsActiveTask(Task_LinkSave))
+            if (!FuncIsActiveTask(Task_LinkFullSave))
                 data[0] = 3;
             break;
         }

src/title_screen.c

@@ -698,7 +698,7 @@ static void SetTitleScreenScene_Cry(s16 * data)
             SetSaveBlocksPointers();
             ResetMenuAndMonGlobals();
             Save_ResetSaveCounters();
-            Save_LoadGameData(SAVE_NORMAL);
+            LoadGameSave(SAVE_NORMAL);
             if (gSaveFileStatus == SAVE_STATUS_EMPTY || gSaveFileStatus == SAVE_STATUS_INVALID)
                 Sav2_ClearSetDefault();
             SetPokemonCryStereo(gSaveBlock2Ptr->optionsSound);

src/trade_scene.c

@@ -2587,7 +2587,7 @@ static void CB2_HandleTradeEnded(void)
             MEvent_RecordIdOfWonderCardSenderByEventType(2, gLinkPlayers[GetMultiplayerId() ^ 1].trainerId);
         }
         SetContinueGameWarpStatusToDynamicWarp();
-        SaveGame_AfterLinkTrade();
+        LinkFullSave_Init();
         gMain.state++;
         sTradeData->timer = 0;
         break;
@@ -2598,7 +2598,7 @@ static void CB2_HandleTradeEnded(void)
         }
         break;
     case 52:
-        if (AfterLinkTradeSaveFailed())
+        if (LinkFullSave_WriteSector())
         {
             ClearContinueGameWarpStatus2();
             gMain.state = 4;
@@ -2610,7 +2610,7 @@ static void CB2_HandleTradeEnded(void)
         }
         break;
     case 4:
-        ClearSaveAfterLinkTradeSaveFailure();
+        LinkFullSave_ReplaceLastSector();
         gMain.state = 40;
         sTradeData->timer = 0;
         break;
@@ -2642,7 +2642,7 @@ static void CB2_HandleTradeEnded(void)
     case 42:
         if (IsLinkTaskFinished())
         {
-            sub_80DA434();
+            LinkFullSave_SetLastSectorSignature();
             gMain.state = 5;
         }
         break;