snes9xgx/source/ngc/mcsave.cpp

/****************************************************************************
 * Snes9x 1.50
 *
 * Nintendo Gamecube Port
 * softdev July 2006
 * crunchy2 May-June 2007
 *
 * mcsave.cpp
 *
 * Memory Card Save Routines.
 ****************************************************************************/
#include <gccore.h>
#include <ogcsys.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#include "snes9x.h"
#include "memmap.h"
#include "debug.h"
#include "cpuexec.h"
#include "ppu.h"
#include "apu.h"
#include "display.h"
#include "gfx.h"
#include "soundux.h"
#include "spc700.h"
#include "spc7110.h"

#include "snes9xGX.h"
#include "video.h"
#include "ftfont.h"
#include "s9xconfig.h"
#include "audio.h"
#include "menu.h"
#include "sram.h"
#include "preferences.h"
#include "mcsave.h"

#define VERIFBUFFERSIZE 65536
static u8 SysArea[CARD_WORKAREA] ATTRIBUTE_ALIGN (32);
unsigned char savebuffer[SAVEBUFFERSIZE] ATTRIBUTE_ALIGN (32);
unsigned char verifbuffer[VERIFBUFFERSIZE] ATTRIBUTE_ALIGN (32);
card_dir CardDir;
card_file CardFile;
card_stat CardStatus;


/****************************************************************************
 * Clear the savebuffer
 ****************************************************************************/
void
ClearSaveBuffer ()
{
    memset (savebuffer, 0, SAVEBUFFERSIZE);
}


/****************************************************************************
 * CardFileExists
 *
 * Wrapper to search through the files on the card.
 * Returns TRUE if found.
 ****************************************************************************/
int
CardFileExists (char *filename, int slot)
{
  int CardError;

  CardError = CARD_FindFirst (slot, &CardDir, TRUE);
  while (CardError != CARD_ERROR_NOFILE)
    {
      CardError = CARD_FindNext (&CardDir);

      if (strcmp ((char *) CardDir.filename, filename) == 0)
	return 1;
    }

  return 0;
}

/****************************************************************************
 * MountCard
 *
 * Mounts the memory card in the given slot. Error checking is done and
 * workarounds implemented for when the mount fails.
 * Returns the result of the last attempted CARD_Mount command.
 ****************************************************************************/
int MountCard(int cslot)
{	
	int ret;
	int tries;
	
	EXI_ProbeReset(); 

	/*** Mount the card ***/
	ret = CARD_Mount (cslot, SysArea, NULL);

	tries = 0;
	while ( tries < 3 && ret == CARD_ERROR_IOERROR )
	{
		if (cslot == CARD_SLOTA)
			WaitPrompt("Replug card in slot A!");
		else
			WaitPrompt("Replug card in slot B!");
		
		ShowAction("");
		ret = CARD_Mount (cslot, SysArea, NULL);
		tries++;
	}
	
	tries = 0;
	while ( tries < 5 && ret == CARD_ERROR_NOCARD )
	{
		ShowAction("Mounting card...");
		CARD_Unmount (cslot);
		usleep(500000); // wait half second
		ShowAction("");
		usleep(500000); // wait half second
		ret = CARD_Mount (cslot, SysArea, NULL);
		tries++;
	}

	tries = 0;
	while ( tries < 5 && ret == CARD_ERROR_UNLOCKED )
	{
		ShowAction("Waiting for unlock...");
		usleep(500000); // wait half second
		ShowAction("");
		usleep(500000); // wait half second
		ret = CARD_Probe(cslot);
		tries++;
	}
	
	return ret;
}


/****************************************************************************
 * Verify Memory Card file against buffer
 ****************************************************************************/
int
VerifyMCFile (unsigned char *buf, int slot, char *filename, int datasize)
{
	int CardError;
	unsigned int blocks;
	unsigned int SectorSize;
	char msg[80];
    int bytesleft = 0;
    int bytesread = 0;

	/*** Initialize Card System ***/
	memset (SysArea, 0, CARD_WORKAREA);
	CARD_Init ("SNES", "00");
	
	/*** Try to mount the card ***/
	CardError = MountCard(slot);
	
	if (CardError == 0)
	{
		/*** Get Sector Size ***/
		CARD_GetSectorSize (slot, &SectorSize);
		
		if (!CardFileExists (filename, slot))
		{
            CARD_Unmount (slot);
		    WaitPrompt ("Unable to open file for verify!");
			return 0;
		}
		
		memset (&CardFile, 0, sizeof (CardFile));
		CardError = CARD_Open (slot, filename, &CardFile);
		
		blocks = CardFile.len;
		
		if (blocks < SectorSize)
			blocks = SectorSize;
		
		if (blocks % SectorSize)
			blocks += SectorSize;
			
        if (blocks > (unsigned int)datasize)
            blocks = datasize;
		
		memset (verifbuffer, 0, VERIFBUFFERSIZE);
		bytesleft = blocks;
		bytesread = 0;
		while (bytesleft > 0)
		{
			CARD_Read (&CardFile, verifbuffer, SectorSize, bytesread);
			if ( memcmp (buf + bytesread, verifbuffer, (unsigned int)bytesleft < SectorSize ? bytesleft : SectorSize) )
            {
                CARD_Close (&CardFile);
                CARD_Unmount (slot);
                WaitPrompt ("File did not verify!");
                return 0;
            }
                    
			bytesleft -= SectorSize;
			bytesread += SectorSize;
			
            sprintf (msg, "Verified %d of %d bytes", bytesread, blocks);
            ShowProgress (msg, bytesread, blocks);
		}
		CARD_Close (&CardFile);
		CARD_Unmount (slot);
		
		return 1;
	}
	else
		if (slot == CARD_SLOTA)
			WaitPrompt ("Unable to Mount Slot A Memory Card!");
		else
			WaitPrompt ("Unable to Mount Slot B Memory Card!");
	
	return 0;
}


/****************************************************************************
 * Load savebuffer from Memory Card file
 ****************************************************************************/
int
LoadBufferFromMC (unsigned char *buf, int slot, char *filename, bool8 silent)
{
	int CardError;
	unsigned int blocks;
	unsigned int SectorSize;
	char msg[80];
    int bytesleft = 0;
    int bytesread = 0;

	/*** Initialize Card System ***/
	memset (SysArea, 0, CARD_WORKAREA);
	CARD_Init ("SNES", "00");
	
	/*** Try to mount the card ***/
	CardError = MountCard(slot);
	
	if (CardError == 0)
	{
		/*** Get Sector Size ***/
		CARD_GetSectorSize (slot, &SectorSize);
		
		if (!CardFileExists (filename, slot))
		{
			if ( !silent )
				WaitPrompt ("Unable to open file");
			return 0;
		}
		
		memset (&CardFile, 0, sizeof (CardFile));
		CardError = CARD_Open (slot, filename, &CardFile);
		
		blocks = CardFile.len;
		
		if (blocks < SectorSize)
			blocks = SectorSize;
		
		if (blocks % SectorSize)
			blocks += SectorSize;
		
		memset (buf, 0, 0x22000);
		
		bytesleft = blocks;
		bytesread = 0;
		while (bytesleft > 0)
		{
			CARD_Read (&CardFile, buf + bytesread, SectorSize, bytesread);
			bytesleft -= SectorSize;
			bytesread += SectorSize;
        
            sprintf (msg, "Read %d of %d bytes", bytesread, blocks);
            ShowProgress (msg, bytesread, blocks);
		}
		CARD_Close (&CardFile);
		CARD_Unmount (slot);
	}
	else
		if (slot == CARD_SLOTA)
			WaitPrompt ("Unable to Mount Slot A Memory Card!");
		else
			WaitPrompt ("Unable to Mount Slot B Memory Card!");
	
	return bytesread;
}


/****************************************************************************
 * Write savebuffer to Memory Card file
 ****************************************************************************/
int
SaveBufferToMC (unsigned char *buf, int slot, char *filename, int datasize, bool8 silent)
{
	int CardError;
	unsigned int blocks;
	unsigned int SectorSize;
	char msg[80];
	
	/*** Initialize Card System ***/
	memset (SysArea, 0, CARD_WORKAREA);
	CARD_Init ("SNES", "00");
	
	/*** Try to mount the card ***/
	CardError = MountCard(slot);
	
	if (CardError == 0)
	{
		/*** Get Sector Size ***/
		CARD_GetSectorSize (slot, &SectorSize);
		
		if (datasize)
		{			
			/*** Calculate number of blocks required ***/
			blocks = (datasize / SectorSize) * SectorSize;
			if (datasize % SectorSize)
				blocks += SectorSize;
						
			/*** Does this file exist ? ***/
			if (CardFileExists (filename, slot))
			{
				/*** Try to open the file ***/
				CardError = CARD_Open (slot, filename, &CardFile);
				if (CardError)
				{
                    CARD_Unmount (slot);
					WaitPrompt ("Unable to open card file!");
					return 0;
				}
				
//                 if ( (s32)blocks < CardFile.len )  /*** new data is shorter ***/
//                 {
//                     CARD_Close (&CardFile);                    
//                     
//                     /*** Delete the existing longer file ***/
//                     CardError = CARD_Delete(slot, filename);
//                     if (CardError)
//                     {
//                         CARD_Unmount (slot);
//                         WaitPrompt ("Unable to delete existing file!");
//                         return 0;
//                     }
//                     
//                     /*** Create new, shorter file ***/
//                     CardError = CARD_Create (slot, filename, blocks, &CardFile);
//                     if (CardError)
//                     {
//                         CARD_Unmount (slot);
//                         WaitPrompt ("Unable to create updated card file!");
//                         return 0;
//                     }
//                    
// 				}
// 				else 
				
				if ( (s32)blocks > CardFile.len )  /*** new data is longer ***/
				{
                    CARD_Close (&CardFile);
                   
                    /*** Try to create temp file to check available space ***/
                    CardError = CARD_Create (slot, "TEMPFILESNES9XGX201", blocks, &CardFile);
                    if (CardError)
                    {
                        CARD_Unmount (slot);
                        WaitPrompt ("Not enough space to update file!");
                        return 0;
                    }
                    
                    /*** Delete the temporary file ***/
                    CARD_Close (&CardFile);
                    CardError = CARD_Delete(slot, "TEMPFILESNES9XGX201");
                    if (CardError)
                    {
                        CARD_Unmount (slot);
                        WaitPrompt ("Unable to delete temporary file!");
                        return 0;
                    }
                    
                    /*** Delete the existing shorter file ***/
                    CardError = CARD_Delete(slot, filename);
                    if (CardError)
                    {
                        CARD_Unmount (slot);
                        WaitPrompt ("Unable to delete existing file!");
                        return 0;
                    }
                    
                    /*** Create new, longer file ***/
                    CardError = CARD_Create (slot, filename, blocks, &CardFile);
                    if (CardError)
                    {
                        CARD_Unmount (slot);
                        WaitPrompt ("Unable to create updated card file!");
                        return 0;
                    }
				}
			}
			else  /*** no file existed, create new one ***/
			{
                /*** Create new file ***/
                CardError = CARD_Create (slot, filename, blocks, &CardFile);
                if (CardError)
                {
                    CARD_Unmount (slot);
                    if ( CardError = CARD_ERROR_INSSPACE )
                        WaitPrompt ("Not enough space to create file!");
                    else
                        WaitPrompt ("Unable to create card file!");
                    return 0;
                }
            }
			
			/*** Now, have an open file handle, ready to send out the data ***/
			CARD_GetStatus (slot, CardFile.filenum, &CardStatus);
			CardStatus.icon_addr = 0x0;
			CardStatus.icon_fmt = 2;
			CardStatus.icon_speed = 1;
			CardStatus.comment_addr = 2048;
			CARD_SetStatus (slot, CardFile.filenum, &CardStatus);
			
			int byteswritten = 0;
			int bytesleft = blocks;
			while (bytesleft > 0)
			{
				CardError =
					CARD_Write (&CardFile, buf + byteswritten,
                                SectorSize, byteswritten);
				bytesleft -= SectorSize;
				byteswritten += SectorSize;
				
                sprintf (msg, "Wrote %d of %d bytes", byteswritten, blocks);
                ShowProgress (msg, byteswritten, blocks);
			}
			
			CARD_Close (&CardFile);
			CARD_Unmount (slot);
			
			if ( GCSettings.VerifySaves )
			{
			    /*** Verify the written file, but only up to the length we wrote
			         because the file could be longer due to past writes    ***/
                if ( VerifyMCFile (buf, slot, filename, byteswritten) )
                    return byteswritten;
                else
                    return 0;
            }
            else
                return byteswritten;
		}
		else
			if ( !silent )
				WaitPrompt ("This game does not appear to use SRAM");
	}
	else
		if (slot == CARD_SLOTA)
			WaitPrompt ("Unable to Mount Slot A Memory Card!");
		else
			WaitPrompt ("Unable to Mount Slot B Memory Card!");
	
	return 0;

}

/****************************************************************************
 * Memory Card SRAM Load
 ****************************************************************************/
void
LoadSRAMFromMC (int slot, int silent)
{
	char filename[128];

    ShowAction ("Loading SRAM from MC...");

	/*** Build SRAM filename ***/
	sprintf (filename, "%s.srm", Memory.ROMName);
	
	int offset = LoadBufferFromMC (savebuffer, slot, filename, silent);
		
	if ( offset > 0 )
	{
		decodesavedata (offset);
		if ( !silent )
		{
			sprintf (filename, "Loaded %d bytes", offset);
			WaitPrompt (filename);
		}
		S9xSoftReset();
	}
}


/****************************************************************************
 * Memory Card SRAM Save
 ****************************************************************************/
void
SaveSRAMToMC (int slot, int silent)
{
	char filename[128];
	int datasize;
	int offset;

    ShowAction ("Saving SRAM to MC...");

	/*** Build SRAM filename ***/
	sprintf (filename, "%s.srm", Memory.ROMName);

	datasize = prepareMCsavedata ();
	offset = SaveBufferToMC (savebuffer, slot, filename, datasize, silent);
	
	if ( (offset > 0) && (!silent))
	{
		sprintf (filename, "Wrote %d bytes", offset);
		WaitPrompt (filename);
	}
}


/****************************************************************************
 * Memory Card Preferences Load
 ****************************************************************************/
void
LoadPrefsFromMC (int slot, int silent)
{
    int offset;
    char msg[80];

    ShowAction ("Loading Prefs from MC...");
    
    offset = LoadBufferFromMC (savebuffer, slot, PREFS_FILE_NAME, silent);

	if ( offset > 0 )
	{
		decodePrefsData ();
		if ( !silent )
		{
			sprintf (msg, "Loaded %d bytes", offset);
			WaitPrompt (msg);
		}
	}
}


/****************************************************************************
 * Memory Card Preferences Save
 ****************************************************************************/
void
SavePrefsToMC (int slot, int silent)
{
	int datasize;
	int offset;
	char msg[80];

    ShowAction ("Saving Prefs to MC...");

    datasize = preparePrefsData ();
	offset = SaveBufferToMC (savebuffer, slot, PREFS_FILE_NAME, datasize, silent);

	if ( offset > 0 && !silent)
	{
		sprintf (msg, "Wrote %d bytes", offset);
		WaitPrompt (msg);
	}
}