fio.c File Reference

Go to the source code of this file.

Data Structures
struct	SaveInfo

Macros
#define	GLOBALS_PAGE_1   6
#define	GLOBALS_PAGE_2   7

Functions
b32	fio_read_flash (s32 pageNum, void *readBuffer, u32 numBytes)
b32	fio_write_flash (s32 pageNum, s8 *readBuffer, u32 numBytes)
void	fio_erase_flash (s32 pageNum)
s32	get_spirits_rescued (void)
s32	fio_calc_globals_checksum (void)
b32	fio_validate_globals_checksums (void)
b32	fio_load_globals (void)
b32	fio_save_globals (void)
s32	fio_calc_file_checksum (SaveData *saveData)
b32	fio_validate_file_checksum (SaveData *saveData)
b32	fio_fetch_saved_file_info (void)
b32	fio_load_game (s32 saveSlot)
void	fio_save_game (s32 saveSlot)
void	fio_erase_game (s32 saveSlot)
void	fio_init_flash (void)

Variables
BSS SaveData	FetchSaveBuffer
BSS SaveInfo	LogicalSaveInfo [4]
BSS SaveInfo	PhysicalSaveInfo [6]
BSS s32	NextAvailablePhysicalSave
SaveGlobals	gSaveGlobals
SaveData	gCurrentSaveFile
char	MagicSaveString [] = "Mario Story 006"

---

Data Structure Documentation

SaveInfo

struct SaveInfo

Data Fields
s32	slot
s32	count

Macro Definition Documentation

GLOBALS_PAGE_1

#define GLOBALS_PAGE_1   6

Definition at line 12 of file fio.c.

Referenced by fio_load_globals(), and fio_save_globals().

GLOBALS_PAGE_2

#define GLOBALS_PAGE_2   7

Definition at line 13 of file fio.c.

Referenced by fio_load_globals(), and fio_save_globals().

Function Documentation

fio_read_flash()

b32 fio_read_flash	(	s32	pageNum,
		void *	readBuffer,
		u32	numBytes )

Definition at line 236 of file fio.c.

                                                                {
    OSIoMesg mb;
    OSMesgQueue mesgQueue;
    OSMesg mesg;
    s8* buf = (s8*)readBuffer;
    s32 amt;
    u16 i;
 
    osInvalDCache(buf, numBytes);
    osCreateMesgQueue(&mesgQueue, &mesg, 1);
 
    i = 0;
    while (numBytes != 0) {
        if (numBytes > sizeof(SaveGlobals)) {
            amt = sizeof(SaveGlobals);
        } else {
            amt = numBytes;
        }
 
        osFlashReadArray(&mb, 0, pageNum * sizeof(SaveGlobals) + i, buf, 1, &mesgQueue);
        osRecvMesg(&mesgQueue, NULL, 1);
        i++;
        numBytes -= amt;
        buf += amt;
    }
    return TRUE;
}

Referenced by fio_fetch_saved_file_info(), fio_load_game(), and fio_load_globals().

fio_write_flash()

b32 fio_write_flash	(	s32	pageNum,
		s8 *	readBuffer,
		u32	numBytes )

Definition at line 264 of file fio.c.

                                                               {
    OSIoMesg mb;
    OSMesgQueue mesgQueue;
    OSMesg mesg;
    s32 amt;
    u16 i;
 
    osWritebackDCache(readBuffer, numBytes);
    osCreateMesgQueue(&mesgQueue, &mesg, 1);
 
    i = 0;
    while (numBytes != 0) {
        if (numBytes > sizeof(SaveGlobals)) {
            amt = sizeof(SaveGlobals);
        } else {
            amt = numBytes;
        }
 
        osFlashWriteBuffer(&mb, 0, readBuffer, &mesgQueue);
        osFlashWriteArray((pageNum * sizeof(SaveGlobals)) + i);
        osRecvMesg(&mesgQueue, NULL, 1);
        i++;
        numBytes -= amt;
        readBuffer += amt;
    }
    return TRUE;
}

Referenced by fio_save_game(), and fio_save_globals().

fio_erase_flash()

void fio_erase_flash

(

s32

pageNum

)

Definition at line 292 of file fio.c.

                                  {
    osFlashSectorErase(pageNum * sizeof(SaveGlobals));
}

Referenced by fio_erase_game(), fio_save_game(), and fio_save_globals().

get_spirits_rescued()

s32 get_spirits_rescued

(

void

)

Definition at line 29 of file fio.c.

                              {
    s32 storyProgress = evt_get_variable(NULL, GB_StoryProgress);
    s32 ret = 7;
 
    if (storyProgress < evt_get_variable(NULL, STORY_CH1_STAR_SPIRIT_RESCUED)) {
        ret = 0;
    } else if (storyProgress < evt_get_variable(NULL, STORY_CH2_STAR_SPIRIT_RESCUED)) {
        ret = 1;
    } else if (storyProgress < evt_get_variable(NULL, STORY_CH3_STAR_SPIRIT_RESCUED)) {
        ret = 2;
    } else if (storyProgress < evt_get_variable(NULL, STORY_CH4_STAR_SPIRIT_RESCUED)) {
        ret = 3;
    } else if (storyProgress < evt_get_variable(NULL, STORY_CH5_OPENED_ESCAPE_ROUTE)) {
        ret = 4;
    } else if (storyProgress < evt_get_variable(NULL, STORY_CH6_STAR_SPIRIT_RESCUED)) {
        ret = 5;
    } else if (storyProgress < evt_get_variable(NULL, STORY_CH7_STAR_SPIRIT_RESCUED)) {
        ret = 6;
    }
 
    return ret;
}

Referenced by fio_save_game().

fio_calc_globals_checksum()

s32 fio_calc_globals_checksum

(

void

)

Definition at line 52 of file fio.c.

                                    {
    s32* it = (s32*)&gSaveGlobals;
    u32 sum = 0;
    u32 i;
 
    for (i = 0; i < sizeof(gSaveGlobals) / sizeof(*it); i++) {
        sum += *it++;
    }
    return sum;
}

Referenced by fio_save_globals(), and fio_validate_globals_checksums().

fio_validate_globals_checksums()

b32 fio_validate_globals_checksums

(

void

)

Definition at line 63 of file fio.c.

                                         {
    SaveGlobals* header = &gSaveGlobals;
 
    if (strcmp(header->magicString, MagicSaveString)) {
        return FALSE;
    }
    if (header->crc1 != ~header->crc2) {
        return FALSE;
    }
    return fio_calc_globals_checksum() == header->crc1;
}

Referenced by fio_load_globals().

fio_load_globals()

b32 fio_load_globals

(

void

)

Definition at line 75 of file fio.c.

                           {
    fio_read_flash(GLOBALS_PAGE_1, &gSaveGlobals, sizeof(gSaveGlobals));
    if (fio_validate_globals_checksums()) {
        return TRUE;
    }
 
    fio_read_flash(GLOBALS_PAGE_2, &gSaveGlobals, sizeof(gSaveGlobals));
    if (fio_validate_globals_checksums()) {
        return TRUE;
    }
 
    bzero(&gSaveGlobals, sizeof(gSaveGlobals));
    return FALSE;
}

Referenced by filemenu_init(), and state_step_startup().

fio_save_globals()

b32 fio_save_globals

(

void

)

Definition at line 90 of file fio.c.

                           {
    s32 checksum;
 
    strcpy(gSaveGlobals.magicString, MagicSaveString);
    gSaveGlobals.crc1 = 0;
    gSaveGlobals.crc2 = ~gSaveGlobals.crc1;
    checksum = fio_calc_globals_checksum();
    gSaveGlobals.crc1 = checksum;
    gSaveGlobals.crc2 = ~checksum;
    fio_erase_flash(GLOBALS_PAGE_1);
    fio_write_flash(GLOBALS_PAGE_1, (s8*)&gSaveGlobals, sizeof(gSaveGlobals));
    fio_erase_flash(GLOBALS_PAGE_2);
    fio_write_flash(GLOBALS_PAGE_2, (s8*)&gSaveGlobals, sizeof(gSaveGlobals));
    return TRUE;
}

Referenced by filemenu_yesno_handle_input().

fio_calc_file_checksum()

s32 fio_calc_file_checksum

(

SaveData *

saveData

)

Definition at line 106 of file fio.c.

                                               {
    s32* it = (s32*)saveData;
    u32 sum = 0;
    u32 i;
 
    for (i = 0; i < sizeof(*saveData) / sizeof(*it); i++) {
        sum += *it++;
    }
    return sum;
}

Referenced by fio_save_game(), and fio_validate_file_checksum().

fio_validate_file_checksum()

b32 fio_validate_file_checksum

(

SaveData *

saveData

)

Definition at line 117 of file fio.c.

                                                   {
    if (!strcmp(saveData->magicString, MagicSaveString) && saveData->crc1 == ~saveData->crc2) {
        return fio_calc_file_checksum(saveData) == saveData->crc1;
    }
    return FALSE;
}

Referenced by fio_fetch_saved_file_info().

fio_fetch_saved_file_info()

b32 fio_fetch_saved_file_info

(

void

)

Definition at line 124 of file fio.c.

                                    {
    SaveData* fetchBuf = &FetchSaveBuffer; // temps required to match
    SaveData* validBuf = fetchBuf;
    s32 i, j, minSaveCount;
 
    for (i = 0; i < ARRAY_COUNT(LogicalSaveInfo); i++) {
        LogicalSaveInfo[i].slot = -1;
        LogicalSaveInfo[i].count = -1;
    }
 
    for (i = 0; i < ARRAY_COUNT(PhysicalSaveInfo); i++) {
        fio_read_flash(i, fetchBuf, sizeof(SaveData));
        if (fio_validate_file_checksum(fetchBuf)) {
            PhysicalSaveInfo[i].slot = validBuf->saveSlot;
            PhysicalSaveInfo[i].count = validBuf->saveCount;
            // logical saves only track the most recent physical save for each slot
            if (LogicalSaveInfo[validBuf->saveSlot].count < validBuf->saveCount) {
                LogicalSaveInfo[validBuf->saveSlot].slot = i;
                LogicalSaveInfo[validBuf->saveSlot].count = validBuf->saveCount;
            }
        }
    }
 
    minSaveCount = 0x7FFFFFFF;
    for (j = 0; j < ARRAY_COUNT(PhysicalSaveInfo); j++) {
        // find a logical save for each physical save
        for (i = 0; i < ARRAY_COUNT(LogicalSaveInfo); i++) {
            if (j == LogicalSaveInfo[i].slot) {
                break;
            }
        }
        // condition holds only for physical saves not mapped to logical ones
        if (i == ARRAY_COUNT(LogicalSaveInfo)) {
            if (PhysicalSaveInfo[j].count < minSaveCount) {
                // choose the least-recent unmapped physical save slot
                minSaveCount = PhysicalSaveInfo[j].count;
                NextAvailablePhysicalSave = j;
            }
        }
    }
    return TRUE;
}

Referenced by fio_erase_game(), fio_load_game(), and fio_save_game().

fio_load_game()

b32 fio_load_game

(

s32

saveSlot

)

Definition at line 167 of file fio.c.

                                {
    gGameStatusPtr->saveSlot = saveSlot;
 
    fio_fetch_saved_file_info();
    fio_read_flash(LogicalSaveInfo[saveSlot].slot, &gCurrentSaveFile, MAX(sizeof(VanillaSaveData), sizeof(SaveData)));
 
    if (strcmp(gCurrentSaveFile.magicString, MagicSaveString) == 0) {
        if (gGameStatusPtr->saveCount < gCurrentSaveFile.saveCount) {
            gGameStatusPtr->saveCount = gCurrentSaveFile.saveCount;
        }
        fio_deserialize_state();
        gSaveSlotSummary[gGameStatusPtr->saveSlot] = gCurrentSaveFile.summary;
        return TRUE;
    }
    return FALSE;
}

Referenced by filemenu_init(), filemenu_main_handle_input(), filemenu_yesno_handle_input(), and state_step_startup().

fio_save_game()

void fio_save_game

(

s32

saveSlot

)

Definition at line 184 of file fio.c.

                                 {
    fio_fetch_saved_file_info();
 
    gGameStatusPtr->saveSlot = saveSlot;
 
    fio_serialize_state();
 
    gSaveSlotSummary[gGameStatusPtr->saveSlot].level = gPlayerData.level;
    gSaveSlotSummary[gGameStatusPtr->saveSlot].spiritsRescued = get_spirits_rescued();
    gSaveSlotSummary[gGameStatusPtr->saveSlot].timePlayed = gPlayerData.frameCounter;
 
    gCurrentSaveFile.summary = gSaveSlotSummary[gGameStatusPtr->saveSlot];
 
    strcpy(gCurrentSaveFile.magicString, MagicSaveString);
 
    // adding 1 accounts for null terminator
    ASSERT(1 + strlen(DX_MOD_NAME) < ARRAY_COUNT(gCurrentSaveFile.modName));
 
    strcpy(gCurrentSaveFile.modName, DX_MOD_NAME);
    gCurrentSaveFile.majorVersion = DX_MOD_VER_MAJOR;
    gCurrentSaveFile.minorVersion = DX_MOD_VER_MINOR;
    gCurrentSaveFile.patchVersion = DX_MOD_VER_PATCH;
 
    gCurrentSaveFile.saveSlot = saveSlot;
    gGameStatusPtr->saveCount++;
    gCurrentSaveFile.saveCount = gGameStatusPtr->saveCount;
 
    gCurrentSaveFile.crc1 = 0;
    gCurrentSaveFile.crc2 = ~gCurrentSaveFile.crc1;
    gCurrentSaveFile.crc1 = fio_calc_file_checksum(&gCurrentSaveFile);
    gCurrentSaveFile.crc2 = ~gCurrentSaveFile.crc1;
 
    fio_erase_flash(NextAvailablePhysicalSave);
    fio_write_flash(NextAvailablePhysicalSave, (s8*)&gCurrentSaveFile, sizeof(SaveData));
}

Referenced by entity_SaveBlock_save_data(), filemenu_main_handle_input(), and filemenu_yesno_handle_input().

fio_erase_game()

void fio_erase_game

(

s32

saveSlot

)

Definition at line 220 of file fio.c.

                                  {
    s32 i;
 
    fio_fetch_saved_file_info();
 
    for (i = 0; i < ARRAY_COUNT(PhysicalSaveInfo); i++) {
        if (PhysicalSaveInfo[i].slot == saveSlot) {
            fio_erase_flash(i);
        }
    }
}

Referenced by filemenu_yesno_handle_input().

fio_init_flash()

void fio_init_flash

(

void

)

Definition at line 232 of file fio.c.

                          {
    osFlashInit();
}

Referenced by load_engine_data().

Variable Documentation

FetchSaveBuffer

BSS SaveData FetchSaveBuffer

Definition at line 15 of file fio.c.

Referenced by fio_fetch_saved_file_info().

LogicalSaveInfo

BSS SaveInfo LogicalSaveInfo[4]

Definition at line 16 of file fio.c.

Referenced by fio_fetch_saved_file_info(), and fio_load_game().

PhysicalSaveInfo

BSS SaveInfo PhysicalSaveInfo[6]

Definition at line 17 of file fio.c.

Referenced by fio_erase_game(), and fio_fetch_saved_file_info().

NextAvailablePhysicalSave

BSS s32 NextAvailablePhysicalSave

Definition at line 18 of file fio.c.

Referenced by fio_fetch_saved_file_info(), and fio_save_game().

gSaveGlobals

SaveGlobals gSaveGlobals

Definition at line 20 of file fio.c.

Referenced by filemenu_init(), filemenu_yesno_handle_input(), fio_calc_globals_checksum(), fio_load_globals(), fio_save_globals(), fio_validate_globals_checksums(), and state_step_startup().

gCurrentSaveFile

SaveData gCurrentSaveFile

Definition at line 21 of file fio.c.

Referenced by clear_area_flag(), clear_area_flags(), clear_global_flag(), clear_saved_variables(), filemenu_init(), fio_deserialize_state(), fio_load_game(), fio_save_game(), fio_serialize_state(), get_area_byte(), get_area_flag(), get_global_byte(), get_global_flag(), get_global_short(), get_global_word(), set_area_byte(), set_area_flag(), set_global_byte(), set_global_flag(), set_global_short(), set_global_word(), and ver_deserialize_standard().

MagicSaveString

char MagicSaveString[] = "Mario Story 006"

Definition at line 23 of file fio.c.

Referenced by fio_load_game(), fio_save_game(), fio_save_globals(), fio_validate_file_checksum(), and fio_validate_globals_checksums().