summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorProjectRevoTPP <projectrevotpp@hotmail.com>2017-03-18 03:55:18 +0100
committerProjectRevoTPP <projectrevotpp@hotmail.com>2017-03-18 03:55:18 +0100
commitdccef9735be0de0b43ca0a6743ff0493f132554c (patch)
tree7a971fb2cb4364d8559564ea245821aa8c6d8447
parent823496db7694c7098c5dedc94445b26ca5c6cc91 (diff)
rewrite, label, and document save.c
-rw-r--r--src/save.c425
1 files changed, 230 insertions, 195 deletions
diff --git a/src/save.c b/src/save.c
index 9d70bfffd..b5934e231 100644
--- a/src/save.c
+++ b/src/save.c
@@ -1,58 +1,83 @@
#include "global.h"
+#include "gba/flash_internal.h"
#include "gba/gba.h"
#include "save.h"
#include "asm.h"
-#include "gba/flash_internal.h"
#include "load_save.h"
#include "rom4.h"
#include "save_failed_screen.h"
-extern struct SaveSection unk_2000000;
-
-extern u32 gUnknown_02039284;
-
-extern u16 gUnknown_03005E9C;
-extern u32 gUnknown_03005EA0;
-extern u16 gUnknown_03005EA4;
-extern u32 gUnknown_03005EA8;
-extern u32 gUnknown_03005EAC;
-extern struct SaveSection *gUnknown_03005EB0;
+extern u32 gLastSaveSectorStatus; // used but in an unferenced function, so unused
+extern u16 gLastWrittenSector;
+extern u32 gLastSaveCounter;
+extern u16 gLastKnownGoodSector;
+extern u32 gDamagedSaveSectors;
+extern u32 gSaveCounter;
+extern struct SaveSection unk_2000000; // slow save RAM
+extern struct SaveSection *gFastSaveSection; // the pointer is in fast IWRAM but may sometimes point to the slower EWRAM.
extern u16 gUnknown_03005EB4;
extern u16 gSaveFileStatus;
-extern u32 gUnknown_03005EBC;
+extern u32 gGameContinueCallback;
-extern struct SaveSectionLocation gSaveSectionLocations[];
-extern struct SaveSectionLocation gHallOfFameSaveSectionLocations[];
-extern u8 gUnknown_08401E24[];
+extern struct PokemonStorage gPokemonStorage;
+extern struct HallOfFame gHallOfFame;
+
+const struct SaveSectionLocation gSaveSectionLocations[] =
+{
+ {((u8 *) &gSaveBlock2), 0x890},
+ {((u8 *) &gSaveBlock1) + 0xF80 * 0, 0xF80},
+ {((u8 *) &gSaveBlock1) + 0xF80 * 1, 0xF80},
+ {((u8 *) &gSaveBlock1) + 0xF80 * 2, 0xF80},
+ {((u8 *) &gSaveBlock1) + 0xF80 * 3, 0xC40},
+ {((u8 *) &gPokemonStorage) + 0xF80 * 0, 0xF80},
+ {((u8 *) &gPokemonStorage) + 0xF80 * 1, 0xF80},
+ {((u8 *) &gPokemonStorage) + 0xF80 * 2, 0xF80},
+ {((u8 *) &gPokemonStorage) + 0xF80 * 3, 0xF80},
+ {((u8 *) &gPokemonStorage) + 0xF80 * 4, 0xF80},
+ {((u8 *) &gPokemonStorage) + 0xF80 * 5, 0xF80},
+ {((u8 *) &gPokemonStorage) + 0xF80 * 6, 0xF80},
+ {((u8 *) &gPokemonStorage) + 0xF80 * 7, 0xF80},
+ {((u8 *) &gPokemonStorage) + 0xF80 * 8, 0x7D0}
+};
+
+const struct SaveSectionLocation gHallOfFameSaveSectionLocations[] =
+{
+ {((u8 *) &gHallOfFame) + 0xF80 * 0, 0xF80},
+ {((u8 *) &gHallOfFame) + 0xF80 * 1, 0xF80}
+};
+
+const u8 gFlashSectors[] = { 0x1E, 0x1F };
void ClearSaveData(void)
{
u16 i;
- for (i = 0; i < 32; i++)
+
+ for (i = 0; i < NUM_SECTORS; i++)
EraseFlashSector(i);
}
-void sub_81251B8(void)
+// ResetSaveCounters
+void ResetSaveCounters(void)
{
- gUnknown_03005EAC = 0;
- gUnknown_03005E9C = 0;
- gUnknown_03005EA8 = 0;
+ gSaveCounter = 0;
+ gLastWrittenSector = 0;
+ gDamagedSaveSectors = 0;
}
-bool32 sub_81251D4(u8 op, u8 bit)
+bool32 SetDamagedSectorBits(u8 op, u8 bit)
{
bool32 retVal = FALSE;
switch (op)
{
- case 0:
- gUnknown_03005EA8 |= 1 << bit;
+ case ENABLE:
+ gDamagedSaveSectors |= (1 << bit);
break;
- case 1:
- gUnknown_03005EA8 &= ~(1 << bit);
+ case DISABLE:
+ gDamagedSaveSectors &= ~(1 << bit);
break;
- case 2:
- if (gUnknown_03005EA8 & (1 << bit))
+ case CHECK: // unused
+ if (gDamagedSaveSectors & (1 << bit))
retVal = TRUE;
break;
}
@@ -60,67 +85,70 @@ bool32 sub_81251D4(u8 op, u8 bit)
return retVal;
}
-u8 save_write_to_flash(u16 a1, struct SaveSectionLocation *a2)
+u8 save_write_to_flash(u16 a1, const struct SaveSectionLocation *location)
{
u32 retVal;
u16 i;
- gUnknown_03005EB0 = &unk_2000000;
+ gFastSaveSection = &unk_2000000;
- if (a1 != 0xFFFF)
+ if (a1 != 0xFFFF) // for link
{
- retVal = sub_81252D8(a1, a2);
+ retVal = HandleWriteSector(a1, location);
}
else
{
- gUnknown_03005EA4 = gUnknown_03005E9C;
- gUnknown_03005EA0 = gUnknown_03005EAC;
- gUnknown_03005E9C++;
- gUnknown_03005E9C = gUnknown_03005E9C % 14;
- gUnknown_03005EAC++;
+ gLastKnownGoodSector = gLastWrittenSector; // backup the current written sector before attempting to write.
+ gLastSaveCounter = gSaveCounter;
+ gLastWrittenSector++;
+ gLastWrittenSector = gLastWrittenSector % 14;
+ gSaveCounter++;
retVal = 1;
+
for (i = 0; i < 14; i++)
- sub_81252D8(i, a2);
- if (gUnknown_03005EA8)
+ HandleWriteSector(i, location);
+
+ if (gDamagedSaveSectors != 0) // skip the damaged sector.
{
retVal = 0xFF;
- gUnknown_03005E9C = gUnknown_03005EA4;
- gUnknown_03005EAC = gUnknown_03005EA0;
+ gLastWrittenSector = gLastKnownGoodSector;
+ gSaveCounter = gLastSaveCounter;
}
}
return retVal;
}
-u8 sub_81252D8(u16 a1, struct SaveSectionLocation *a2)
+u8 HandleWriteSector(u16 a1, const struct SaveSectionLocation *location)
{
u16 i;
u16 sector;
u8 *data;
u16 size;
- sector = a1 + gUnknown_03005E9C;
+ sector = a1 + gLastWrittenSector;
sector %= 14;
- sector += 14 * (gUnknown_03005EAC % 2);
+ sector += 14 * (gSaveCounter % 2);
- data = a2[a1].data;
- size = a2[a1].size;
+ data = location[a1].data;
+ size = location[a1].size;
+ // clear save section.
for (i = 0; i < sizeof(struct SaveSection); i++)
- ((char *)gUnknown_03005EB0)[i] = 0;
+ ((char *)gFastSaveSection)[i] = 0;
- gUnknown_03005EB0->id = a1;
- gUnknown_03005EB0->unknown = 0x8012025;
- gUnknown_03005EB0->counter = gUnknown_03005EAC;
+ gFastSaveSection->id = a1;
+ gFastSaveSection->security = UNKNOWN_CHECK_VALUE;
+ gFastSaveSection->counter = gSaveCounter;
for (i = 0; i < size; i++)
- gUnknown_03005EB0->data[i] = data[i];
+ gFastSaveSection->data[i] = data[i];
- gUnknown_03005EB0->checksum = sub_8125C10(data, size);
- return sub_8125440(sector, gUnknown_03005EB0->data);
+ gFastSaveSection->checksum = CalculateChecksum(data, size);
+ return TryWriteSector(sector, gFastSaveSection->data);
}
-u8 sub_81253C8(u8 sector, u8 *data, u16 size)
+u8 HandleWriteSectorNBytes(u8 sector, u8 *data, u16 size)
{
u16 i;
struct SaveSection *section = &unk_2000000;
@@ -128,66 +156,66 @@ u8 sub_81253C8(u8 sector, u8 *data, u16 size)
for (i = 0; i < sizeof(struct SaveSection); i++)
((char *)section)[i] = 0;
- section->unknown = 0x8012025;
+ section->security = UNKNOWN_CHECK_VALUE;
for (i = 0; i < size; i++)
section->data[i] = data[i];
- section->id = sub_8125C10(data, size); // id instead of checksum?
- return sub_8125440(sector, section->data);
+ section->id = CalculateChecksum(data, size); // though this appears to be incorrect, it might be some sector checksum instead of a whole save checksum and only appears to be relevent to HOF data, if used.
+ return TryWriteSector(sector, section->data);
}
-u8 sub_8125440(u8 sector, u8 *data)
+u8 TryWriteSector(u8 sector, u8 *data)
{
- if (ProgramFlashSectorAndVerify(sector, data))
+ if (ProgramFlashSectorAndVerify(sector, data) != 0) // is damaged?
{
- sub_81251D4(0, sector);
+ SetDamagedSectorBits(ENABLE, sector); // set damaged sector bits.
return 0xFF;
}
else
{
- sub_81251D4(1, sector);
+ SetDamagedSectorBits(DISABLE, sector); // unset damaged sector bits. it's safe now.
return 1;
}
}
-u32 sub_812546C(struct SaveSectionLocation *a1)
+u32 RestoreSaveBackupVarsAndIncrement(const struct SaveSectionLocation *location) // location is unused
{
- gUnknown_03005EB0 = &unk_2000000;
- gUnknown_03005EA4 = gUnknown_03005E9C;
- gUnknown_03005EA0 = gUnknown_03005EAC;
- gUnknown_03005E9C++;
- gUnknown_03005E9C = gUnknown_03005E9C % 14;
- gUnknown_03005EAC++;
+ gFastSaveSection = &unk_2000000;
+ gLastKnownGoodSector = gLastWrittenSector;
+ gLastSaveCounter = gSaveCounter;
+ gLastWrittenSector++;
+ gLastWrittenSector = gLastWrittenSector % 14;
+ gSaveCounter++;
gUnknown_03005EB4 = 0;
- gUnknown_03005EA8 = 0;
+ gDamagedSaveSectors = 0;
return 0;
}
-u32 sub_81254C8(struct SaveSectionLocation *a1)
+u32 RestoreSaveBackupVars(const struct SaveSectionLocation *location) // only ever called once, and gSaveBlock2 is passed to this function. location is unused
{
- gUnknown_03005EB0 = &unk_2000000;
- gUnknown_03005EA4 = gUnknown_03005E9C;
- gUnknown_03005EA0 = gUnknown_03005EAC;
+ gFastSaveSection = &unk_2000000;
+ gLastKnownGoodSector = gLastWrittenSector;
+ gLastSaveCounter = gSaveCounter;
gUnknown_03005EB4 = 0;
- gUnknown_03005EA8 = 0;
+ gDamagedSaveSectors = 0;
return 0;
}
-u8 sub_812550C(u16 a1, struct SaveSectionLocation *a2)
+u8 sub_812550C(u16 a1, const struct SaveSectionLocation *location)
{
u8 retVal;
if (gUnknown_03005EB4 < a1 - 1)
{
retVal = 1;
- sub_81252D8(gUnknown_03005EB4, a2);
+ HandleWriteSector(gUnknown_03005EB4, location);
gUnknown_03005EB4++;
- if (gUnknown_03005EA8)
+ if (gDamagedSaveSectors)
{
retVal = 0xFF;
- gUnknown_03005E9C = gUnknown_03005EA4;
- gUnknown_03005EAC = gUnknown_03005EA0;
+ gLastWrittenSector = gLastKnownGoodSector;
+ gSaveCounter = gLastSaveCounter;
}
}
else
@@ -198,20 +226,22 @@ u8 sub_812550C(u16 a1, struct SaveSectionLocation *a2)
return retVal;
}
-u8 sub_812556C(u16 a1, struct SaveSectionLocation *a2)
+u8 sub_812556C(u16 a1, const struct SaveSectionLocation *location)
{
u8 retVal = 1;
- sub_81255B8(a1 - 1, a2);
- if (gUnknown_03005EA8)
+
+ sub_81255B8(a1 - 1, location);
+
+ if (gDamagedSaveSectors)
{
retVal = 0xFF;
- gUnknown_03005E9C = gUnknown_03005EA4;
- gUnknown_03005EAC = gUnknown_03005EA0;
+ gLastWrittenSector = gLastKnownGoodSector;
+ gSaveCounter = gLastSaveCounter;
}
return retVal;
}
-u8 sub_81255B8(u16 a1, struct SaveSectionLocation *a2)
+u8 sub_81255B8(u16 a1, const struct SaveSectionLocation *location)
{
u16 i;
u16 sector;
@@ -219,32 +249,35 @@ u8 sub_81255B8(u16 a1, struct SaveSectionLocation *a2)
u16 size;
u8 status;
- sector = a1 + gUnknown_03005E9C;
+ sector = a1 + gLastWrittenSector;
sector %= 14;
- sector += 14 * (gUnknown_03005EAC % 2);
+ sector += 14 * (gSaveCounter % 2);
- data = a2[a1].data;
- size = a2[a1].size;
+ data = location[a1].data;
+ size = location[a1].size;
+ // clear temp save section.
for (i = 0; i < sizeof(struct SaveSection); i++)
- ((char *)gUnknown_03005EB0)[i] = 0;
+ ((char *)gFastSaveSection)[i] = 0;
- gUnknown_03005EB0->id = a1;
- gUnknown_03005EB0->unknown = 0x8012025;
- gUnknown_03005EB0->counter = gUnknown_03005EAC;
+ gFastSaveSection->id = a1;
+ gFastSaveSection->security = UNKNOWN_CHECK_VALUE;
+ gFastSaveSection->counter = gSaveCounter;
+ // set temp section's data.
for (i = 0; i < size; i++)
- gUnknown_03005EB0->data[i] = data[i];
+ gFastSaveSection->data[i] = data[i];
- gUnknown_03005EB0->checksum = sub_8125C10(data, size);
+ // calculate checksum.
+ gFastSaveSection->checksum = CalculateChecksum(data, size);
EraseFlashSector(sector);
status = 1;
- for (i = 0; i < 0xFF8; i++)
+ for (i = 0; i < sizeof(struct UnkSaveSection); i++)
{
- if (ProgramFlashByte(sector, i, ((u8 *)gUnknown_03005EB0)[i]))
+ if (ProgramFlashByte(sector, i, ((u8 *)gFastSaveSection)[i]))
{
status = 0xFF;
break;
@@ -253,7 +286,7 @@ u8 sub_81255B8(u16 a1, struct SaveSectionLocation *a2)
if (status == 0xFF)
{
- sub_81251D4(0, sector);
+ SetDamagedSectorBits(ENABLE, sector);
return 0xFF;
}
else
@@ -262,7 +295,7 @@ u8 sub_81255B8(u16 a1, struct SaveSectionLocation *a2)
for (i = 0; i < 7; i++)
{
- if (ProgramFlashByte(sector, 0xFF9 + i, ((u8 *)gUnknown_03005EB0)[0xFF9 + i]))
+ if (ProgramFlashByte(sector, 0xFF9 + i, ((u8 *)gFastSaveSection)[0xFF9 + i]))
{
status = 0xFF;
break;
@@ -271,105 +304,107 @@ u8 sub_81255B8(u16 a1, struct SaveSectionLocation *a2)
if (status == 0xFF)
{
- sub_81251D4(0, sector);
+ SetDamagedSectorBits(ENABLE, sector);
return 0xFF;
}
else
{
- sub_81251D4(1, sector);
+ SetDamagedSectorBits(DISABLE, sector);
return 1;
}
}
}
-u8 sub_8125758(u16 a1, struct SaveSectionLocation *a2)
+u8 sub_8125758(u16 a1, const struct SaveSectionLocation *location)
{
u16 sector;
- sector = a1 + gUnknown_03005E9C - 1;
+ sector = a1 + gLastWrittenSector - 1;
sector %= 14;
- sector += 14 * (gUnknown_03005EAC % 2);
+ sector += 14 * (gSaveCounter % 2);
- if (ProgramFlashByte(sector, 0xFF8, ((u8 *)gUnknown_03005EB0)[0xFF8]))
+ if (ProgramFlashByte(sector, sizeof(struct UnkSaveSection), ((u8 *)gFastSaveSection)[sizeof(struct UnkSaveSection)]))
{
- sub_81251D4(0, sector);
- gUnknown_03005E9C = gUnknown_03005EA4;
- gUnknown_03005EAC = gUnknown_03005EA0;
+ // sector is damaged, so enable the bit in gDamagedSaveSectors and restore the last written sector and save counter.
+ SetDamagedSectorBits(ENABLE, sector);
+ gLastWrittenSector = gLastKnownGoodSector;
+ gSaveCounter = gLastSaveCounter;
return 0xFF;
}
else
{
- sub_81251D4(1u, sector);
+ SetDamagedSectorBits(DISABLE, sector);
return 1;
}
}
-u8 sub_81257F0(u16 a1, struct SaveSectionLocation *a2)
+u8 sub_81257F0(u16 a1, const struct SaveSectionLocation *location)
{
u16 sector;
- sector = a1 + gUnknown_03005E9C - 1;
+ sector = a1 + gLastWrittenSector - 1;
sector %= 14;
- sector += 14 * (gUnknown_03005EAC % 2);
+ sector += 14 * (gSaveCounter % 2);
- if (ProgramFlashByte(sector, 0xFF8, 0x25))
+ if (ProgramFlashByte(sector, sizeof(struct UnkSaveSection), 0x25))
{
- sub_81251D4(0, sector);
- gUnknown_03005E9C = gUnknown_03005EA4;
- gUnknown_03005EAC = gUnknown_03005EA0;
+ // sector is damaged, so enable the bit in gDamagedSaveSectors and restore the last written sector and save counter.
+ SetDamagedSectorBits(ENABLE, sector);
+ gLastWrittenSector = gLastKnownGoodSector;
+ gSaveCounter = gLastSaveCounter;
return 0xFF;
}
else
{
- sub_81251D4(1u, sector);
+ SetDamagedSectorBits(DISABLE, sector);
return 1;
}
}
-u8 sub_812587C(u16 a1, struct SaveSectionLocation *a2)
+u8 sub_812587C(u16 a1, const struct SaveSectionLocation *location)
{
u8 retVal;
- gUnknown_03005EB0 = &unk_2000000;
+ gFastSaveSection = &unk_2000000;
if (a1 != 0xFFFF)
{
retVal = 0xFF;
}
else
{
- retVal = sub_8125974(a2);
- sub_81258BC(0xFFFF, a2);
+ retVal = sub_8125974(location);
+ sub_81258BC(0xFFFF, location);
}
return retVal;
}
-u8 sub_81258BC(u16 a1, struct SaveSectionLocation *a2)
+u8 sub_81258BC(u16 a1, const struct SaveSectionLocation *location)
{
u16 i;
u16 checksum;
- u16 v3 = 14 * (gUnknown_03005EAC % 2);
+ u16 v3 = 14 * (gSaveCounter % 2);
u16 id;
for (i = 0; i < 14; i++)
{
- sub_8125BF8(i + v3, gUnknown_03005EB0);
- id = gUnknown_03005EB0->id;
+ sub_8125BF8(i + v3, gFastSaveSection);
+ id = gFastSaveSection->id;
if (id == 0)
- gUnknown_03005E9C = i;
- checksum = sub_8125C10(gUnknown_03005EB0->data, a2[id].size);
- if (gUnknown_03005EB0->unknown == 0x8012025
- && gUnknown_03005EB0->checksum == checksum)
+ gLastWrittenSector = i;
+ checksum = CalculateChecksum(gFastSaveSection->data, location[id].size);
+ if (gFastSaveSection->security == UNKNOWN_CHECK_VALUE
+ && gFastSaveSection->checksum == checksum)
{
u16 j;
- for (j = 0; j < a2[id].size; j++)
- ((u8 *)a2[id].data)[j] = gUnknown_03005EB0->data[j];
+ for (j = 0; j < location[id].size; j++)
+ ((u8 *)location[id].data)[j] = gFastSaveSection->data[j];
}
}
return 1;
}
-u8 sub_8125974(struct SaveSectionLocation *a1)
+u8 sub_8125974(const struct SaveSectionLocation *location)
{
u16 i;
u16 checksum;
@@ -385,15 +420,15 @@ u8 sub_8125974(struct SaveSectionLocation *a1)
for (i = 0; i < 14; i++)
{
- sub_8125BF8(i, gUnknown_03005EB0);
- if (gUnknown_03005EB0->unknown == 0x8012025)
+ sub_8125BF8(i, gFastSaveSection);
+ if (gFastSaveSection->security == UNKNOWN_CHECK_VALUE)
{
v5 = TRUE;
- checksum = sub_8125C10(gUnknown_03005EB0->data, a1[gUnknown_03005EB0->id].size);
- if (gUnknown_03005EB0->checksum == checksum)
+ checksum = CalculateChecksum(gFastSaveSection->data, location[gFastSaveSection->id].size);
+ if (gFastSaveSection->checksum == checksum)
{
- v2 = gUnknown_03005EB0->counter;
- v4 |= 1 << gUnknown_03005EB0->id;
+ v2 = gFastSaveSection->counter;
+ v4 |= 1 << gFastSaveSection->id;
}
}
}
@@ -415,15 +450,15 @@ u8 sub_8125974(struct SaveSectionLocation *a1)
for (i = 0; i < 14; i++)
{
- sub_8125BF8(i + 14, gUnknown_03005EB0);
- if (gUnknown_03005EB0->unknown == 0x8012025)
+ sub_8125BF8(i + 14, gFastSaveSection);
+ if (gFastSaveSection->security == UNKNOWN_CHECK_VALUE)
{
v5 = TRUE;
- checksum = sub_8125C10(gUnknown_03005EB0->data, a1[gUnknown_03005EB0->id].size);
- if (gUnknown_03005EB0->checksum == checksum)
+ checksum = CalculateChecksum(gFastSaveSection->data, location[gFastSaveSection->id].size);
+ if (gFastSaveSection->checksum == checksum)
{
- v3 = gUnknown_03005EB0->counter;
- v4 |= 1 << gUnknown_03005EB0->id;
+ v3 = gFastSaveSection->counter;
+ v4 |= 1 << gFastSaveSection->id;
}
}
}
@@ -446,22 +481,22 @@ u8 sub_8125974(struct SaveSectionLocation *a1)
{
if ((unsigned)(v2 + 1) < (unsigned)(v3 + 1))
{
- gUnknown_03005EAC = v3;
+ gSaveCounter = v3;
}
else
{
- gUnknown_03005EAC = v2;
+ gSaveCounter = v2;
}
}
else
{
if (v2 < v3)
{
- gUnknown_03005EAC = v3;
+ gSaveCounter = v3;
}
else
{
- gUnknown_03005EAC = v2;
+ gSaveCounter = v2;
}
}
return 1;
@@ -469,7 +504,7 @@ u8 sub_8125974(struct SaveSectionLocation *a1)
if (v14 == 1)
{
- gUnknown_03005EAC = v2;
+ gSaveCounter = v2;
if (v10 == 255)
return 255;
return 1;
@@ -477,7 +512,7 @@ u8 sub_8125974(struct SaveSectionLocation *a1)
if (v10 == 1)
{
- gUnknown_03005EAC = v3;
+ gSaveCounter = v3;
if (v14 == 255)
return 255;
return 1;
@@ -485,13 +520,13 @@ u8 sub_8125974(struct SaveSectionLocation *a1)
if (v14 == 0 && v10 == 0)
{
- gUnknown_03005EAC = 0;
- gUnknown_03005E9C = 0;
+ gSaveCounter = 0;
+ gLastWrittenSector = 0;
return 0;
}
- gUnknown_03005EAC = 0;
- gUnknown_03005E9C = 0;
+ gSaveCounter = 0;
+ gLastWrittenSector = 0;
return 2;
}
@@ -500,9 +535,9 @@ u8 sub_8125B88(u8 a1, u8 *data, u16 size)
u16 i;
struct SaveSection *section = &unk_2000000;
sub_8125BF8(a1, section);
- if (section->unknown == 0x8012025)
+ if (section->security == UNKNOWN_CHECK_VALUE)
{
- u16 checksum = sub_8125C10(section->data, size);
+ u16 checksum = CalculateChecksum(section->data, size);
if (section->id == checksum)
{
for (i = 0; i < size; i++)
@@ -522,11 +557,11 @@ u8 sub_8125B88(u8 a1, u8 *data, u16 size)
u8 sub_8125BF8(u8 sector, struct SaveSection *section)
{
- ReadFlash(sector, 0, section->data, 0x1000);
+ ReadFlash(sector, 0, section->data, sizeof(struct SaveSection));
return 1;
}
-u16 sub_8125C10(void *data, u16 size)
+u16 CalculateChecksum(void *data, u16 size)
{
u16 i;
u32 checksum = 0;
@@ -537,37 +572,37 @@ u16 sub_8125C10(void *data, u16 size)
return ((checksum >> 16) + checksum);
}
-u8 sub_8125C3C(u8 a1)
+u8 HandleSavingData(u8 saveType)
{
u8 i;
- switch (a1)
+ switch (saveType)
{
- case 5:
+ case HOF_DELETE_SAVE: // deletes save before HOF case. unused
for (i = 28; i < 32; i++)
EraseFlashSector(i);
- case 3:
+ case HOF_SAVE: // hall of fame.
if (GetGameStat(10) < 999)
IncrementGameStat(10);
for (i = 0; i < 2; i++)
- sub_81253C8(28 + i, gHallOfFameSaveSectionLocations[i].data, gHallOfFameSaveSectionLocations[i].size);
+ HandleWriteSectorNBytes(28 + i, gHallOfFameSaveSectionLocations[i].data, gHallOfFameSaveSectionLocations[i].size);
SaveSerializedGame();
save_write_to_flash(0xFFFF, gSaveSectionLocations);
break;
- case 0:
+ case NORMAL_SAVE: // normal save.
default:
SaveSerializedGame();
save_write_to_flash(0xFFFF, gSaveSectionLocations);
break;
- case 1:
+ case LINK_SAVE: // link save. update only the pokemon, i think.
SaveSerializedGame();
for (i = 0; i < 5; i++)
save_write_to_flash(i, gSaveSectionLocations);
break;
- case 2:
+ case EREADER_SAVE: // used in mossdeep "game corner" before/after battling old man e-reader trainer
SaveSerializedGame();
save_write_to_flash(0, gSaveSectionLocations);
break;
- case 4:
+ case DIFFERENT_FILE_SAVE: // there is a different file, so erase the file and overwrite it completely.
for (i = 28; i < 32; i++)
EraseFlashSector(i);
SaveSerializedGame();
@@ -577,49 +612,49 @@ u8 sub_8125C3C(u8 a1)
return 0;
}
-u8 sub_8125D44(u8 a1)
+u8 TrySavingData(u8 saveType) // TrySave
{
if (gFlashMemoryPresent != TRUE)
return 0xFF;
- sub_8125C3C(a1);
- if (!gUnknown_03005EA8)
+ HandleSavingData(saveType);
+ if (!gDamagedSaveSectors)
return 1;
- DoSaveFailedScreen(a1);
+ DoSaveFailedScreen(saveType);
return 0xFF;
}
-u8 sub_8125D80(void)
+u8 sub_8125D80(void) // trade.s save
{
if (gFlashMemoryPresent != TRUE)
return 1;
SaveSerializedGame();
- sub_812546C(gSaveSectionLocations);
+ RestoreSaveBackupVarsAndIncrement(gSaveSectionLocations);
return 0;
}
-bool8 sub_8125DA8(void)
+bool8 sub_8125DA8(void) // trade.s save
{
- u8 v0 = sub_812550C(14, gSaveSectionLocations);
- if (gUnknown_03005EA8)
+ u8 retVal = sub_812550C(14, gSaveSectionLocations);
+ if (gDamagedSaveSectors)
DoSaveFailedScreen(0);
- if (v0 == 0xFF)
+ if (retVal == 0xFF)
return 1;
else
return 0;
}
-u8 sub_8125DDC(void)
+u8 sub_8125DDC(void) // trade.s save
{
sub_812556C(14, gSaveSectionLocations);
- if (gUnknown_03005EA8)
+ if (gDamagedSaveSectors)
DoSaveFailedScreen(0);
return 0;
}
-u8 sub_8125E04(void)
+u8 sub_8125E04(void) // trade.s save
{
sub_8125758(14, gSaveSectionLocations);
- if (gUnknown_03005EA8)
+ if (gDamagedSaveSectors)
DoSaveFailedScreen(0);
return 0;
}
@@ -630,7 +665,7 @@ u8 sub_8125E2C(void)
return 1;
SaveSerializedGame();
- sub_81254C8(gSaveSectionLocations);
+ RestoreSaveBackupVars(gSaveSectionLocations);
sub_812556C(gUnknown_03005EB4 + 1, gSaveSectionLocations);
return 0;
}
@@ -649,7 +684,7 @@ u8 sub_8125E6C(void)
sub_81257F0(val, gSaveSectionLocations);
retVal = 1;
}
- if (gUnknown_03005EA8)
+ if (gDamagedSaveSectors)
DoSaveFailedScreen(1);
return retVal;
}
@@ -671,7 +706,7 @@ u8 sub_8125EC8(u8 a1)
result = sub_812587C(0xFFFF, gSaveSectionLocations);
LoadSerializedGame();
gSaveFileStatus = result;
- gUnknown_03005EBC = 0;
+ gGameContinueCallback = 0;
break;
case 3:
result = sub_8125B88(28, gHallOfFameSaveSectionLocations[0].data, gHallOfFameSaveSectionLocations[0].size);
@@ -688,12 +723,12 @@ bool8 unref_sub_8125F4C(struct UnkSaveSection *a1)
u16 i;
char *raw = (char *)a1;
- for (i = 0; i < 0x1000; i++)
+ for (i = 0; i < sizeof(struct SaveSection); i++)
raw[i] = 0;
- ReadFlash(gUnknown_08401E24[0], 0, a1->data, 4096);
+ ReadFlash(gFlashSectors[0], 0, a1->data, 4096);
- if (a1->unknown != 0x8012025)
+ if (a1->security != UNKNOWN_CHECK_VALUE)
return FALSE;
return TRUE;
@@ -702,10 +737,10 @@ bool8 unref_sub_8125F4C(struct UnkSaveSection *a1)
u8 unref_sub_8125FA0(void)
{
u16 i;
- u8 v0 = sub_8125D44(0);
+ u8 v0 = TrySavingData(0);
for (i = 0; i < 2; i++)
- EraseFlashSector(gUnknown_08401E24[i]);
+ EraseFlashSector(gFlashSectors[i]);
if (v0 == 255)
{
@@ -727,25 +762,25 @@ u8 unref_sub_8125FF0(u8 *data, u16 size)
u16 i;
struct UnkSaveSection *section = (struct UnkSaveSection *)&unk_2000000;
- for (i = 0; i < 0x1000; i++)
+ for (i = 0; i < sizeof(struct SaveSection); i++)
((char *)section)[i] = 0;
- section->unknown = 0x8012025;
+ section->security = UNKNOWN_CHECK_VALUE;
for (i = 0; i < size; i++)
section->data[i] = data[i];
- gUnknown_02039284 = ProgramFlashSectorAndVerifyNBytes(gUnknown_08401E24[0], (u8 *)section, 0x1000);
+ gLastSaveSectorStatus = ProgramFlashSectorAndVerifyNBytes(gFlashSectors[0], (u8 *)section, sizeof(struct SaveSection));
- if (gUnknown_02039284)
- return 255;
+ if (gLastSaveSectorStatus)
+ return 0xFF;
else
return 1;
}
u8 unref_sub_8126068(u8 sector, u8 *data, u32 size)
{
- if (ProgramFlashSectorAndVerify(sector, data, size))
+ if (ProgramFlashSectorAndVerify(sector, data))
return 255;
else
return 1;
@@ -753,6 +788,6 @@ u8 unref_sub_8126068(u8 sector, u8 *data, u32 size)
u8 unref_sub_8126080(u8 sector, u8 *data)
{
- ReadFlash(sector, 0, data, 0x1000);
+ ReadFlash(sector, 0, data, sizeof(struct SaveSection));
return 1;
}