import from github

include/save.h

@@ -0,0 +1,115 @@
+#ifndef GUARD_SAVE_H
+#define GUARD_SAVE_H
+
+// 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 4084
+#define SECTOR_FOOTER_SIZE 12
+#define SECTOR_SIZE (SECTOR_DATA_SIZE + SECTOR_FOOTER_SIZE)
+
+#define NUM_SAVE_SLOTS 2
+
+// If the sector's security field is not this value then the sector is either invalid or empty.
+#define SECTOR_SECURITY_NUM 0x8012025
+
+#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_HILL       30
+#define SECTOR_ID_RECORDED_BATTLE    31
+#define SECTORS_COUNT                32
+
+#define NUM_HOF_SECTORS 2
+
+#define SAVE_STATUS_EMPTY    0
+#define SAVE_STATUS_OK       1
+#define SAVE_STATUS_CORRUPT  2
+#define SAVE_STATUS_NO_FLASH 4
+#define SAVE_STATUS_ERROR    0xFF
+
+// Special sector id value for certain save functions to
+// indicate that no specific sector should be used.
+#define FULL_SAVE_SLOT 0xFFFF
+
+// SetDamagedSectorBits states
+enum
+{
+    ENABLE,
+    DISABLE,
+    CHECK // unused
+};
+
+// Do save types
+enum
+{
+    SAVE_NORMAL,
+    SAVE_LINK, // Link / Battle Frontier
+    //EREADER_SAVE, // deprecated in Emerald
+    SAVE_LINK2, // unknown 2nd link save
+    SAVE_HALL_OF_FAME,
+    SAVE_OVERWRITE_DIFFERENT_FILE,
+    SAVE_HALL_OF_FAME_ERASE_BEFORE // unused
+};
+
+// 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
+{
+    void *data;
+    u16 size;
+};
+
+struct SaveSector
+{
+    u8 data[SECTOR_DATA_SIZE];
+    u8 unused[SECTOR_FOOTER_SIZE - 12]; // Unused portion of the footer
+    u16 id;
+    u16 checksum;
+    u32 security;
+    u32 counter;
+}; // size is SECTOR_SIZE (0x1000)
+
+#define SECTOR_SECURITY_OFFSET offsetof(struct SaveSector, security)
+#define SECTOR_COUNTER_OFFSET offsetof(struct SaveSector, counter)
+
+extern u16 gLastWrittenSector;
+extern u32 gLastSaveCounter;
+extern u16 gLastKnownGoodSector;
+extern u32 gDamagedSaveSectors;
+extern u32 gSaveCounter;
+extern struct SaveSector *gFastSaveSector;
+extern u16 gIncrementalSectorId;
+extern u16 gSaveFileStatus;
+extern void (*gGameContinueCallback)(void);
+extern struct SaveSectorLocation gRamSaveSectorLocations[];
+
+extern struct SaveSector gSaveDataBuffer;
+
+void ClearSaveData(void);
+void Save_ResetSaveCounters(void);
+u8 HandleSavingData(u8 saveType);
+u8 TrySavingData(u8 saveType);
+bool8 LinkFullSave_Init(void);
+bool8 LinkFullSave_WriteSector(void);
+bool8 LinkFullSave_ReplaceLastSector(void);
+bool8 LinkFullSave_SetLastSectorSecurity(void);
+bool8 WriteSaveBlock2(void);
+bool8 WriteSaveBlock1Sector(void);
+u8 LoadGameSave(u8 saveType);
+u16 GetSaveBlocksPointersBaseOffset(void);
+u32 TryReadSpecialSaveSector(u8 sector, u8* dst);
+u32 TryWriteSpecialSaveSector(u8 sector, u8* src);
+void Task_LinkFullSave(u8 taskId);
+
+// save_failed_screen.c
+void DoSaveFailedScreen(u8 saveType);
+
+#endif // GUARD_SAVE_H