Mirror/GodMode9
1
0
Fork 1
mirror of https://github.com/d0k3/GodMode9.git synced 2025-06-26 13:42:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Completely refactor SPI.h, write CTR flash

Browse Source 
Also (hopefully?) write Art Academy, and also implement sector-based
write on Sanyo 256K chips.
This commit is contained in:
Balint Kovacs 2019-07-27 01:58:20 +02:00 committed by d0k3
parent 004341e1ef
commit 48d8c48d12
3 changed files with 307 additions and 209 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

409
arm9/source/gamecart/spi.c
View File

@ -1,5 +1,7 @@
/* /*
* This file is part of TWLSaveTool. * This file is based on SPI.cpp from TWLSaveTool. Its copyright notice is
* reproduced below.
*
* Copyright (C) 2015-2016 TuxSH * Copyright (C) 2015-2016 TuxSH
* *
* TWLSaveTool is free software: you can redistribute it and/or modify * TWLSaveTool is free software: you can redistribute it and/or modify
@ -20,13 +22,90 @@
#include "spicard.h" #include "spicard.h"
#include "timer.h" #include "timer.h"
// Deliberately written in C! (except for a few lines) // declarations for actual implementations
int SPIEnableWriting_512B(CardType type);
int SPIEnableWriting_regular(CardType type);
int SPIReadSaveData_9bit(CardType type, u32 offset, void* data, u32 size);
int SPIReadSaveData_16bit(CardType type, u32 offset, void* data, u32 size);
int SPIReadSaveData_24bit(CardType type, u32 offset, void* data, u32 size);
int SPIWriteSaveData_9bit(CardType type, u32 offset, const void* data, u32 size);
int SPIWriteSaveData_16bit(CardType type, u32 offset, const void* data, u32 size);
int SPIWriteSaveData_24bit_write(CardType type, u32 offset, const void* data, u32 size);
int SPIWriteSaveData_24bit_erase_program(CardType type, u32 offset, const void* data, u32 size);
int SPIEraseSector_emulated(CardType type, u32 offset);
int SPIEraseSector_real(CardType type, u32 offset);
// u8* fill_buf = NULL; const CardTypeData EEPROM_512B_ = { SPIEnableWriting_512B, SPIReadSaveData_9bit, SPIWriteSaveData_9bit, SPIEraseSector_emulated, 0xffffff, 1 << 9, 16, 16, 16, false, 0, 0, 0 };
int SPIWriteRead(CardType type, void* cmd, u32 cmdSize, void* answer, u32 answerSize, void* data, u32 dataSize) { const CardTypeData EEPROM_STD_DUMMY = { SPIEnableWriting_regular, SPIReadSaveData_16bit, SPIWriteSaveData_16bit, SPIEraseSector_emulated, 0xffffff, UINT32_MAX, 1, 1, 1, false, SPI_EEPROM_CMD_WRITE, 0, 0 };
const CardTypeData EEPROMTypes[] = {
{ SPIEnableWriting_regular, SPIReadSaveData_16bit, SPIWriteSaveData_16bit, SPIEraseSector_emulated, 0xffffff, 1 << 13, 32, 32, 32, false, SPI_EEPROM_CMD_WRITE, 0, 0}, // EEPROM 8 KB
{ SPIEnableWriting_regular, SPIReadSaveData_16bit, SPIWriteSaveData_16bit, SPIEraseSector_emulated, 0xffffff, 1 << 16, 128, 128, 128, false, SPI_EEPROM_CMD_WRITE, 0, 0}, // EEPROM 64 KB
{ SPIEnableWriting_regular, SPIReadSaveData_24bit, SPIWriteSaveData_24bit_write, SPIEraseSector_emulated, 0xffffff, 1 << 17, 256, 256, 256, false, SPI_EEPROM_CMD_WRITE, 0, 0}, // EEPROM 128 KB
};
const CardTypeData FLASH_STD_DUMMY = { NULL, SPIReadSaveData_24bit, NULL, NULL, 0x0, 0, 0, 0, 0, false, 0, 0, 0 };
const CardTypeData FlashStdTypes[] = {
// NTR/TWL
{ SPIEnableWriting_regular, SPIReadSaveData_24bit, SPIWriteSaveData_24bit_write, SPIEraseSector_real, 0x204012, 1 << 18, 65536, 256, 256, false, SPI_FLASH_CMD_PW, SPI_CMD_PP, SPI_FLASH_CMD_SE },
{ SPIEnableWriting_regular, SPIReadSaveData_24bit, SPIWriteSaveData_24bit_erase_program, SPIEraseSector_real, 0x621600, 1 << 18, 65536, 256, 65536, false, SPI_FLASH_CMD_PW, SPI_CMD_PP, SPI_FLASH_CMD_SE },
{ SPIEnableWriting_regular, SPIReadSaveData_24bit, SPIWriteSaveData_24bit_write, SPIEraseSector_real, 0x204013, 1 << 19, 65536, 256, 256, false, SPI_FLASH_CMD_PW, SPI_CMD_PP, SPI_FLASH_CMD_SE },
{ SPIEnableWriting_regular, SPIReadSaveData_24bit, SPIWriteSaveData_24bit_write, SPIEraseSector_real, 0x621100, 1 << 19, 65536, 256, 256, false, SPI_FLASH_CMD_PW, SPI_CMD_PP, SPI_FLASH_CMD_SE },
{ SPIEnableWriting_regular, SPIReadSaveData_24bit, SPIWriteSaveData_24bit_write, SPIEraseSector_real, 0x204014, 1 << 20, 65536, 256, 256, false, SPI_FLASH_CMD_PW, SPI_CMD_PP, SPI_FLASH_CMD_SE },
// Untested (but pretty safe bet), for Art Academy
{ SPIEnableWriting_regular, SPIReadSaveData_24bit, SPIWriteSaveData_24bit_erase_program, SPIEraseSector_real, 0x202017, 1 << 23, 65536, 32, 65536, false, SPI_FLASH_CMD_PW, SPI_CMD_PP, SPI_FLASH_CMD_SE },
{ SPIEnableWriting_regular, SPIReadSaveData_24bit, SPIWriteSaveData_24bit_erase_program, SPIEraseSector_real, 0x204017, 1 << 23, 65536, 32, 65536, false, SPI_FLASH_CMD_PW, SPI_CMD_PP, SPI_FLASH_CMD_SE },
// CTR
{ SPIEnableWriting_regular, SPIReadSaveData_24bit, SPIWriteSaveData_24bit_erase_program, SPIEraseSector_real, 0xC22210, 1 << 16, 4096, 32, 4096, false, SPI_FLASH_CMD_PW, SPI_CMD_PP, SPI_FLASH_CMD_MXIC_SE },
{ SPIEnableWriting_regular, SPIReadSaveData_24bit, SPIWriteSaveData_24bit_erase_program, SPIEraseSector_real, 0xC22211, 1 << 17, 4096, 32, 4096, false, SPI_FLASH_CMD_PW, SPI_CMD_PP, SPI_FLASH_CMD_MXIC_SE },
{ SPIEnableWriting_regular, SPIReadSaveData_24bit, SPIWriteSaveData_24bit_erase_program, SPIEraseSector_real, 0xC22212, 1 << 18, 4096, 32, 4096, false, SPI_FLASH_CMD_PW, SPI_CMD_PP, SPI_FLASH_CMD_MXIC_SE },
{ SPIEnableWriting_regular, SPIReadSaveData_24bit, SPIWriteSaveData_24bit_erase_program, SPIEraseSector_real, 0xC22213, 1 << 19, 4096, 32, 4096, false, SPI_FLASH_CMD_PW, SPI_CMD_PP, SPI_FLASH_CMD_MXIC_SE },
{ SPIEnableWriting_regular, SPIReadSaveData_24bit, SPIWriteSaveData_24bit_erase_program, SPIEraseSector_real, 0xC22214, 1 << 20, 4096, 32, 4096, false, SPI_FLASH_CMD_PW, SPI_CMD_PP, SPI_FLASH_CMD_MXIC_SE },
{ SPIEnableWriting_regular, SPIReadSaveData_24bit, SPIWriteSaveData_24bit_erase_program, SPIEraseSector_real, 0xC22215, 1 << 21, 4096, 32, 4096, false, SPI_FLASH_CMD_PW, SPI_CMD_PP, SPI_FLASH_CMD_MXIC_SE },
{ SPIEnableWriting_regular, SPIReadSaveData_24bit, SPIWriteSaveData_24bit_erase_program, SPIEraseSector_real, 0xC22216, 1 << 22, 4096, 32, 4096, false, SPI_FLASH_CMD_PW, SPI_CMD_PP, SPI_FLASH_CMD_MXIC_SE },
{ SPIEnableWriting_regular, SPIReadSaveData_24bit, SPIWriteSaveData_24bit_erase_program, SPIEraseSector_real, 0xC22217, 1 << 23, 4096, 32, 4096, false, SPI_FLASH_CMD_PW, SPI_CMD_PP, SPI_FLASH_CMD_MXIC_SE },
};
const CardTypeData FLASH_INFRARED_DUMMY = { NULL, SPIReadSaveData_24bit, NULL, NULL, 0x0, 0, 0, 0, 0, true, 0, 0, 0 };
const CardTypeData FlashInfraredTypes[] = {
// NTR/TWL
{ SPIEnableWriting_regular, SPIReadSaveData_24bit, SPIWriteSaveData_24bit_write, SPIEraseSector_real, 0x204012, 1 << 18, 65536, 256, 256, true, SPI_FLASH_CMD_PW, SPI_CMD_PP, SPI_FLASH_CMD_SE },
{ SPIEnableWriting_regular, SPIReadSaveData_24bit, SPIWriteSaveData_24bit_erase_program, SPIEraseSector_real, 0x621600, 1 << 18, 65536, 256, 65536, true, SPI_FLASH_CMD_PW, SPI_CMD_PP, SPI_FLASH_CMD_SE },
{ SPIEnableWriting_regular, SPIReadSaveData_24bit, SPIWriteSaveData_24bit_write, SPIEraseSector_real, 0x204013, 1 << 19, 65536, 256, 256, true, SPI_FLASH_CMD_PW, SPI_CMD_PP, SPI_FLASH_CMD_SE },
{ SPIEnableWriting_regular, SPIReadSaveData_24bit, SPIWriteSaveData_24bit_write, SPIEraseSector_real, 0x621100, 1 << 19, 65536, 256, 256, true, SPI_FLASH_CMD_PW, SPI_CMD_PP, SPI_FLASH_CMD_SE },
};
const CardType EEPROM_512B = &EEPROM_512B_;
const CardType EEPROM_8KB = EEPROMTypes + 0;
const CardType EEPROM_64KB = EEPROMTypes + 1;
const CardType EEPROM_128KB = EEPROMTypes + 2;
const CardType FLASH_256KB_1 = FlashStdTypes + 0;
const CardType FLASH_256KB_2 = FlashStdTypes + 1;
const CardType FLASH_512KB_1 = FlashStdTypes + 2;
const CardType FLASH_512KB_2 = FlashStdTypes + 3;
const CardType FLASH_1MB = FlashStdTypes + 4;
const CardType FLASH_8MB_1 = FlashStdTypes + 5;
const CardType FLASH_8MB_2 = FlashStdTypes + 6;
const CardType FLASH_64KB_CTR = FlashStdTypes + 7;
const CardType FLASH_128KB_CTR = FlashStdTypes + 8;
const CardType FLASH_256KB_CTR = FlashStdTypes + 9;
const CardType FLASH_512KB_CTR = FlashStdTypes + 10;
const CardType FLASH_1MB_CTR = FlashStdTypes + 11;
const CardType FLASH_2MB_CTR = FlashStdTypes + 12;
const CardType FLASH_4MB_CTR = FlashStdTypes + 13;
const CardType FLASH_8MB_CTR = FlashStdTypes + 14;
const CardType FLASH_256KB_1_INFRARED = FlashInfraredTypes + 0;
const CardType FLASH_256KB_2_INFRARED = FlashInfraredTypes + 1;
const CardType FLASH_512KB_1_INFRARED = FlashInfraredTypes + 2;
const CardType FLASH_512KB_2_INFRARED = FlashInfraredTypes + 3;
int SPIWriteRead(CardType type, void* cmd, u32 cmdSize, void* answer, u32 answerSize, const void* data, u32 dataSize) {
const u32 headerFooterVal = 0; const u32 headerFooterVal = 0;
bool b = type == FLASH_512KB_INFRARED || type == FLASH_256KB_INFRARED; bool b = type->infrared;
SPICARD_init(); SPICARD_init();
@ -55,11 +134,16 @@ int SPIWaitWriteEnd(CardType type) {
return 0; return 0;
} }
int SPIEnableWriting(CardType type) { int SPIEnableWriting_512B(CardType type) {
u8 cmd = SPI_CMD_WREN;
return SPIWriteRead(type, &cmd, 1, NULL, 0, 0, 0);
}
int SPIEnableWriting_regular(CardType type) {
u8 cmd = SPI_CMD_WREN, statusReg = 0; u8 cmd = SPI_CMD_WREN, statusReg = 0;
int res = SPIWriteRead(type, &cmd, 1, NULL, 0, 0, 0); int res = SPIWriteRead(type, &cmd, 1, NULL, 0, 0, 0);
if(res || type == EEPROM_512B) return res; // Weird, but works (otherwise we're getting an infinite loop for that chip type). if(res) return res;
cmd = SPI_CMD_RDSR; cmd = SPI_CMD_RDSR;
do{ do{
@ -70,6 +154,18 @@ int SPIEnableWriting(CardType type) {
return 0; return 0;
} }
int SPIEnableWriting(CardType type) {
if(type == NO_CHIP) return 1;
return type->enableWriting(type);
}
int _SPIWriteTransaction(CardType type, void* cmd, u32 cmdSize, const void* data, u32 dataSize) {
int res;
if( (res = SPIEnableWriting(type)) ) return res;
if( (res = SPIWriteRead(type, cmd, cmdSize, NULL, 0, (void*) ((u8*) data), dataSize)) ) return res;
return SPIWaitWriteEnd(type);
}
int SPIReadJEDECIDAndStatusReg(CardType type, u32* id, u8* statusReg) { int SPIReadJEDECIDAndStatusReg(CardType type, u32* id, u8* statusReg) {
u8 cmd = SPI_FLASH_CMD_RDID; u8 cmd = SPI_FLASH_CMD_RDID;
u8 reg = 0; u8 reg = 0;
@ -92,100 +188,105 @@ int SPIReadJEDECIDAndStatusReg(CardType type, u32* id, u8* statusReg) {
} }
u32 SPIGetPageSize(CardType type) { u32 SPIGetPageSize(CardType type) {
u32 EEPROMSizes[] = { 16, 32, 128, 256 }; if(type == NO_CHIP) return 0;
if(type == NO_CHIP || type > CHIP_LAST) return 0; return type->pageSize;
else if(type < FLASH_256KB_1) return EEPROMSizes[(int) type]; }
else if(type < FLASH_64KB_CTR ) return 256;
else return 0; // TODO u32 SPIGetEraseSize(CardType type) {
if(type == NO_CHIP) return 0;
return type->eraseSize;
} }
u32 SPIGetCapacity(CardType type) { u32 SPIGetCapacity(CardType type) {
u32 sz[] = { 9, 13, 16, 17, 18, 18, 19, 19, 20, 23, 16, 17, 18, 19, 20, 21, 22, 23, 19, 18 }; if(type == NO_CHIP) return 0;
return type->capacity;
}
if(type == NO_CHIP || type > CHIP_LAST) return 0; int SPIWriteSaveData_9bit(CardType type, u32 offset, const void* data, u32 size) {
else return 1 << sz[(int) type]; u8 cmd[2] = { (offset >= 0x100) ? SPI_512B_EEPROM_CMD_WRHI : SPI_512B_EEPROM_CMD_WRLO, (u8) offset };
return _SPIWriteTransaction(type, cmd, 2, (void*) ((u8*) data), size);
}
int SPIWriteSaveData_16bit(CardType type, u32 offset, const void* data, u32 size) {
u8 cmd[3] = { type->writeCommand, (u8)(offset >> 8), (u8) offset };
return _SPIWriteTransaction(type, cmd, 3, (void*) ((u8*) data), size);
}
int SPIWriteSaveData_24bit_write(CardType type, u32 offset, const void* data, u32 size) {
u8 cmd[4] = { type->writeCommand, (u8)(offset >> 16), (u8)(offset >> 8), (u8) offset };
return _SPIWriteTransaction(type, cmd, 4, (void*) ((u8*) data), size);
}
int SPIWriteSaveData_24bit_erase_program(CardType type, u32 offset, const void* data, u32 size) {
u8 cmd[4] = { type->programCommand };
const u32 pageSize = SPIGetPageSize(type);
const u32 eraseSize = SPIGetEraseSize(type);
int res;
u8 *newData = NULL;
if(offset % eraseSize || size < eraseSize) {
u32 sectorStart = (offset / eraseSize) * eraseSize;
newData = malloc(eraseSize);
if(!newData) return 1;
if( (res = SPIReadSaveData(type, sectorStart, newData, eraseSize)) ) {
free(newData);
return res;
}
memcpy(newData + (offset % eraseSize), data, size);
data = newData;
offset = sectorStart;
}
if( (res = SPIEraseSector(type, offset)) ) {
free(newData);
return res;
}
for(u32 pos = offset; pos < offset + eraseSize; pos += pageSize) {
cmd[1] = (u8)(pos >> 16);
cmd[2] = (u8)(pos >> 8);
cmd[3] = (u8) pos;
if( (res = _SPIWriteTransaction(type, cmd, 4, (void*) ((u8*) data - offset + pos), pageSize)) ) {
free(newData);
return res;
}
}
free(newData);
return 0;
} }
int SPIWriteSaveData(CardType type, u32 offset, const void* data, u32 size) { int SPIWriteSaveData(CardType type, u32 offset, const void* data, u32 size) {
u8 cmd[4] = { 0 }; if(type == NO_CHIP) return 1;
u32 cmdSize = 4;
if(size == 0) return 0;
size = min(size, SPIGetCapacity(type) - offset);
u32 end = offset + size; u32 end = offset + size;
u32 pos = offset; u32 pos = offset;
if(size == 0) return 0; u32 writeSize = type->writeSize;
u32 pageSize = SPIGetPageSize(type); if(writeSize == 0) return 0xC8E13404;
if(pageSize == 0) return 0xC8E13404;
int res = SPIWaitWriteEnd(type); int res = SPIWaitWriteEnd(type);
if(res) return res; if(res) return res;
size = (size <= SPIGetCapacity(type) - offset) ? size : SPIGetCapacity(type) - offset;
while(pos < end) { while(pos < end) {
switch(type) {
case EEPROM_512B:
cmdSize = 2;
cmd[0] = (pos >= 0x100) ? SPI_512B_EEPROM_CMD_WRHI : SPI_512B_EEPROM_CMD_WRLO;
cmd[1] = (u8) pos;
break;
case EEPROM_8KB:
case EEPROM_64KB:
cmdSize = 3;
cmd[0] = SPI_EEPROM_CMD_WRITE;
cmd[1] = (u8)(pos >> 8);
cmd[2] = (u8) pos;
break;
case EEPROM_128KB:
cmdSize = 4;
cmd[0] = SPI_EEPROM_CMD_WRITE;
cmd[1] = (u8)(pos >> 16);
cmd[2] = (u8)(pos >> 8);
cmd[3] = (u8) pos;
break;
case FLASH_256KB_1:
/*
This is what is done in the official implementation, but I think it's wrong
cmdSize = 4;
cmd[0] = SPI_CMD_PP;
cmd[1] = (u8)(pos >> 16);
cmd[2] = (u8)(pos >> 8);
cmd[3] = (u8) pos;
break;
*/
case FLASH_256KB_2:
case FLASH_512KB_1:
case FLASH_512KB_2:
case FLASH_1MB:
case FLASH_512KB_INFRARED:
case FLASH_256KB_INFRARED:
cmdSize = 4;
cmd[0] = SPI_FLASH_CMD_PW;
cmd[1] = (u8)(pos >> 16);
cmd[2] = (u8)(pos >> 8);
cmd[3] = (u8) pos;
break;
case FLASH_8MB:
return 0xC8E13404; // writing is unsupported (so is reading? need to test)
default:
return -1; // never happens
}
u32 remaining = end - pos; u32 remaining = end - pos;
u32 nb = pageSize - (pos % pageSize); u32 nb = writeSize - (pos % writeSize);
u32 dataSize = (remaining < nb) ? remaining : nb; u32 dataSize = (remaining < nb) ? remaining : nb;
if( (res = SPIEnableWriting(type)) ) return res; if( (res = type->writeSaveData(type, pos, (void*) ((u8*) data - offset + pos), dataSize)) ) return res;
if( (res = SPIWriteRead(type, cmd, cmdSize, NULL, 0, (void*) ((u8*) data - offset + pos), dataSize)) ) return res;
if( (res = SPIWaitWriteEnd(type)) ) return res;
pos = ((pos / pageSize) + 1) * pageSize; // truncate pos = ((pos / writeSize) + 1) * writeSize; // truncate
} }
return 0; return 0;
} }
int _SPIReadSaveData_512B_impl(u32 pos, void* data, u32 size) { int SPIReadSaveData_9bit(CardType type, u32 pos, void* data, u32 size) {
u8 cmd[4]; u8 cmd[4];
u32 cmdSize = 2; u32 cmdSize = 2;
@ -197,7 +298,7 @@ int _SPIReadSaveData_512B_impl(u32 pos, void* data, u32 size) {
cmd[0] = SPI_512B_EEPROM_CMD_RDLO; cmd[0] = SPI_512B_EEPROM_CMD_RDLO;
cmd[1] = (u8) pos; cmd[1] = (u8) pos;
int res = SPIWriteRead(EEPROM_512B, cmd, cmdSize, data, len, NULL, 0); int res = SPIWriteRead(type, cmd, cmdSize, data, len, NULL, 0);
if(res) return res; if(res) return res;
read += len; read += len;
@ -209,7 +310,7 @@ int _SPIReadSaveData_512B_impl(u32 pos, void* data, u32 size) {
cmd[0] = SPI_512B_EEPROM_CMD_RDHI; cmd[0] = SPI_512B_EEPROM_CMD_RDHI;
cmd[1] = (u8)(pos + read); cmd[1] = (u8)(pos + read);
int res = SPIWriteRead(EEPROM_512B, cmd, cmdSize, (void*)((u8*)data + read), len, NULL, 0); int res = SPIWriteRead(type, cmd, cmdSize, (void*)((u8*)data + read), len, NULL, 0);
if(res) return res; if(res) return res;
} }
@ -217,85 +318,57 @@ int _SPIReadSaveData_512B_impl(u32 pos, void* data, u32 size) {
return 0; return 0;
} }
int SPIReadSaveData_16bit(CardType type, u32 offset, void* data, u32 size) {
u8 cmd[3] = { SPI_CMD_READ, (u8)(offset >> 8), (u8) offset };
return SPIWriteRead(type, cmd, 3, data, size, NULL, 0);
}
int SPIReadSaveData_24bit(CardType type, u32 offset, void* data, u32 size) {
u8 cmd[4] = { SPI_CMD_READ, (u8)(offset >> 16), (u8)(offset >> 8), (u8) offset };
return SPIWriteRead(type, cmd, 4, data, size, NULL, 0);
}
int SPIReadSaveData(CardType type, u32 offset, void* data, u32 size) { int SPIReadSaveData(CardType type, u32 offset, void* data, u32 size) {
u8 cmd[4] = { SPI_CMD_READ }; if(type == NO_CHIP) return 1;
u32 cmdSize = 4;
if(size == 0) return 0; if(size == 0) return 0;
if(type == NO_CHIP) return 0xC8E13404;
int res = SPIWaitWriteEnd(type); int res = SPIWaitWriteEnd(type);
if(res) return res; if(res) return res;
size = (size <= SPIGetCapacity(type) - offset) ? size : SPIGetCapacity(type) - offset; size = (size <= SPIGetCapacity(type) - offset) ? size : SPIGetCapacity(type) - offset;
u32 pos = offset;
switch(type) {
case EEPROM_512B:
return _SPIReadSaveData_512B_impl(offset, data, size);
break;
case EEPROM_8KB:
case EEPROM_64KB:
cmdSize = 3;
cmd[1] = (u8)(pos >> 8);
cmd[2] = (u8) pos;
break;
case EEPROM_128KB:
cmdSize = 4;
cmd[1] = (u8)(pos >> 16);
cmd[2] = (u8)(pos >> 8);
cmd[3] = (u8) pos;
break;
case FLASH_256KB_1:
case FLASH_256KB_2:
case FLASH_512KB_1:
case FLASH_512KB_2:
case FLASH_1MB:
case FLASH_8MB:
case FLASH_512KB_INFRARED:
case FLASH_256KB_INFRARED:
case FLASH_64KB_CTR:
case FLASH_128KB_CTR:
case FLASH_256KB_CTR:
case FLASH_512KB_CTR:
case FLASH_1MB_CTR:
case FLASH_2MB_CTR:
case FLASH_4MB_CTR:
case FLASH_8MB_CTR:
cmdSize = 4;
cmd[1] = (u8)(pos >> 16);
cmd[2] = (u8)(pos >> 8);
cmd[3] = (u8) pos;
break;
default:
return 0; // never happens
}
return SPIWriteRead(type, cmd, cmdSize, data, size, NULL, 0); return type->readSaveData(type, offset, data, size);
} }
/* int SPIEraseSector(CardType type, u32 offset) { int SPIEraseSector_emulated(CardType type, u32 offset) {
u8 cmd[4] = { SPI_FLASH_CMD_SE, (u8)(offset >> 16), (u8)(offset >> 8), (u8) offset }; u32 blockSize = SPIGetEraseSize(type);
if(type == NO_CHIP || type == FLASH_8MB) return 0xC8E13404; u8 *fill_buf = malloc(SPIGetEraseSize(type));
if (!fill_buf) return 1;
memset(fill_buf, 0xff, blockSize);
offset = (offset / blockSize) * blockSize;
if(type < FLASH_256KB_1 && fill_buf == NULL) { int res = SPIWriteSaveData(type, offset, fill_buf, blockSize);
fill_buf = new u8[0x10000]; free(fill_buf);
memset(fill_buf, 0xff, 0x10000); return res;
} }
int SPIEraseSector_real(CardType type, u32 offset) {
u8 cmd[4] = { type->eraseCommand, (u8)(offset >> 16), (u8)(offset >> 8), (u8) offset };
int res = SPIWaitWriteEnd(type); int res = SPIWaitWriteEnd(type);
if(res) return res;
if(type >= FLASH_256KB_1) { return _SPIWriteTransaction(type, cmd, 4, NULL, 0);
if( (res = SPIEnableWriting(type)) ) return res; }
if( (res = SPIWriteRead(type, cmd, 4, NULL, 0, NULL, 0)) ) return res;
if( (res = SPIWaitWriteEnd(type)) ) return res;
} int SPIEraseSector(CardType type, u32 offset) {
// Simulate the same behavior on EEPROM chips. if(type == NO_CHIP) return 1;
else { return type->eraseSector(type, offset);
u32 sz = SPIGetCapacity(type); }
int res = SPIWriteSaveData(type, 0, fill_buf, (sz < 0x10000) ? sz : 0x10000);
return res;
}
return 0;
} */
// The following routine use code from savegame-manager: // The following routine use code from savegame-manager:
@ -353,9 +426,8 @@ int SPIGetCardType(CardType* type, int infrared) {
u8 sr = 0; u8 sr = 0;
u32 jedec = 0; u32 jedec = 0;
u32 tries = 0; u32 tries = 0;
CardType t = (infrared == 1) ? FLASH_INFRARED_DUMMY : FLASH_STD_DUMMY; CardType t = (infrared == 1) ? &FLASH_INFRARED_DUMMY : &FLASH_STD_DUMMY;
int res; int res;
u32 jedecOrderedList[] = { 0x204012, 0x621600, 0x204013, 0x621100, 0x204014, 0x202017, 0xC22210, 0xC22211, 0xC22212, 0xC22213, 0xC22214, 0xC22215, 0xC22216, 0xC22217 };
u32 maxTries = (infrared == -1) ? 2 : 1; // note: infrared = -1 fails 1/3 of the time u32 maxTries = (infrared == -1) ? 2 : 1; // note: infrared = -1 fails 1/3 of the time
while(tries < maxTries){ while(tries < maxTries){
@ -364,45 +436,54 @@ int SPIGetCardType(CardType* type, int infrared) {
if ((sr & 0xfd) == 0x00 && (jedec != 0x00ffffff)) { break; } if ((sr & 0xfd) == 0x00 && (jedec != 0x00ffffff)) { break; }
if ((sr & 0xfd) == 0xF0 && (jedec == 0x00ffffff)) { t = EEPROM_512B; break; } if ((sr & 0xfd) == 0xF0 && (jedec == 0x00ffffff)) { t = EEPROM_512B; break; }
if ((sr & 0xfd) == 0x00 && (jedec == 0x00ffffff)) { t = EEPROM_STD_DUMMY; break; } if ((sr & 0xfd) == 0x00 && (jedec == 0x00ffffff)) { t = &EEPROM_STD_DUMMY; break; }
++tries; ++tries;
t = FLASH_INFRARED_DUMMY; t = &FLASH_INFRARED_DUMMY;
} }
if(t == EEPROM_512B) { *type = t; return 0; } if(t == EEPROM_512B) { *type = t; return 0; }
else if(t == EEPROM_STD_DUMMY) { else if(t == &EEPROM_STD_DUMMY) {
bool mirrored = false; bool mirrored = false;
size_t i;
if( (res = _SPIIsDataMirrored(t, 8192, &mirrored)) ) return res; for(i = 0; i < sizeof(EEPROMTypes) / sizeof(CardTypeData) - 1; i++) {
if(mirrored) t = EEPROM_8KB; if( (res = _SPIIsDataMirrored(t, SPIGetCapacity(EEPROMTypes + i), &mirrored)) ) return res;
else{ if(mirrored) {
if( (res = _SPIIsDataMirrored(t, 65536, &mirrored)) ) return res; *type = EEPROMTypes + i;
if(mirrored) t = EEPROM_64KB; return 0;
else t = EEPROM_128KB; }
} }
*type = EEPROMTypes + i;
*type = t;
return 0; return 0;
} }
else if(t == FLASH_INFRARED_DUMMY) { else if(t == &FLASH_INFRARED_DUMMY) {
size_t i;
if(infrared == 0) *type = NO_CHIP; // did anything go wrong? if(infrared == 0) *type = NO_CHIP; // did anything go wrong?
if(jedec == jedecOrderedList[0] || jedec == jedecOrderedList[1]) *type = FLASH_256KB_INFRARED; for(i = 0; i < sizeof(FlashInfraredTypes) / sizeof(CardTypeData); i++) {
else *type = FLASH_512KB_INFRARED; if(FlashInfraredTypes[i].jedecId == jedec) {
*type = FlashInfraredTypes + i;
return 0;
}
}
*type = NO_CHIP;
return 0; return 0;
} }
else { else {
if(infrared == 1) *type = NO_CHIP; // did anything go wrong?
if(jedec == 0x204017) { *type = FLASH_8MB; return 0; } // 8MB. savegame-manager: which one? (more work is required to unlock this save chip!)
size_t i; size_t i;
for(i = 0; i < sizeof(jedecOrderedList) / sizeof(int); ++i) { if(infrared == 1) *type = NO_CHIP; // did anything go wrong?
if(jedec == jedecOrderedList[i]) { *type = (CardType)((int) FLASH_256KB_1 + i); return 0; }
for(i = 0; i < sizeof(FlashStdTypes) / sizeof(CardTypeData); i++) {
if(FlashStdTypes[i].jedecId == jedec) {
*type = FlashStdTypes + i;
return 0;
}
} }
*type = NO_CHIP; *type = NO_CHIP;

87
arm9/source/gamecart/spi.h
View File

@ -1,5 +1,7 @@
/* /*
* This file is part of TWLSaveTool. * This file is based on SPI.h from TWLSaveTool. Its copyright notice is
* reproduced below.
*
* Copyright (C) 2015-2016 TuxSH * Copyright (C) 2015-2016 TuxSH
* *
* TWLSaveTool is free software: you can redistribute it and/or modify * TWLSaveTool is free software: you can redistribute it and/or modify
@ -39,61 +41,76 @@ extern "C" {
#define SPI_FLASH_CMD_PW 10 #define SPI_FLASH_CMD_PW 10
#define SPI_FLASH_CMD_RDID 0x9f #define SPI_FLASH_CMD_RDID 0x9f
#define SPI_FLASH_CMD_SE 0xd8 #define SPI_FLASH_CMD_SE 0xd8
#define SPI_FLASH_CMD_PE 0xdb
#define SPI_FLASH_CMD_MXIC_SE 0x20
#define SPI_FLG_WIP 1 #define SPI_FLG_WIP 1
#define SPI_FLG_WEL 2 #define SPI_FLG_WEL 2
// extern u8* fill_buf; typedef struct CardTypeData CardTypeData;
typedef enum {
NO_CHIP = -1,
EEPROM_512B = 0, typedef const CardTypeData * CardType;
EEPROM_8KB = 1, struct CardTypeData {
EEPROM_64KB = 2, int (*enableWriting) (CardType type);
EEPROM_128KB = 3, int (*readSaveData) (CardType type, u32 offset, void* data, u32 size);
EEPROM_STD_DUMMY = 1, int (*writeSaveData) (CardType type, u32 offset, const void* data, u32 size);
int (*eraseSector) (CardType type, u32 offset);
u32 jedecId;
u32 capacity;
u32 eraseSize;
u32 pageSize;
u32 writeSize;
bool infrared;
u8 writeCommand;
u8 programCommand;
u8 eraseCommand;
};
FLASH_256KB_1 = 4, #define NO_CHIP NULL
FLASH_256KB_2 = 5,
FLASH_512KB_1 = 6,
FLASH_512KB_2 = 7,
FLASH_1MB = 8,
FLASH_8MB = 9, // <- can't restore savegames, and maybe not read them atm
FLASH_STD_DUMMY = 4,
FLASH_64KB_CTR = 10, // I am extrapolating from the dataheets, only a few of these have been observed in the wild const CardType EEPROM_512B;
FLASH_128KB_CTR = 11, // Most common, including Ocarina of time 3D
FLASH_256KB_CTR = 12,
FLASH_512KB_CTR = 13, // Also common, including Detective Pikachu
FLASH_1MB_CTR = 14, // For example Pokemon Ultra Sun
FLASH_2MB_CTR = 15,
FLASH_4MB_CTR = 16,
FLASH_8MB_CTR = 17,
// Animal crossing: New leaf???
// (What is that? 3dbrew states 10M, but Macronix only makes powers of 2)
FLASH_512KB_INFRARED = 18, const CardType EEPROM_8KB;
FLASH_256KB_INFRARED = 19, // AFAIK, only "Active Health with Carol Vorderman" has such a flash save memory const CardType EEPROM_64KB;
FLASH_INFRARED_DUMMY = 17, const CardType EEPROM_128KB;
CHIP_LAST = 19, const CardType FLASH_256KB_1;
} CardType; const CardType FLASH_256KB_2;
const CardType FLASH_512KB_1;
const CardType FLASH_512KB_2;
const CardType FLASH_1MB;
const CardType FLASH_8MB_1; // <- can't restore savegames, and maybe not read them atm
const CardType FLASH_8MB_2; // we are also unsure about the ID for this
int SPIWriteRead(CardType type, void* cmd, u32 cmdSize, void* answer, u32 answerSize, void* data, u32 dataSize); const CardType FLASH_64KB_CTR; // I am extrapolating from the dataheets, only a few of these have been observed in the wild
const CardType FLASH_128KB_CTR; // Most common, including Ocarina of time 3D
const CardType FLASH_256KB_CTR;
const CardType FLASH_512KB_CTR; // Also common, including Detective Pikachu
const CardType FLASH_1MB_CTR; // For example Pokemon Ultra Sun
const CardType FLASH_2MB_CTR;
const CardType FLASH_4MB_CTR;
const CardType FLASH_8MB_CTR;
const CardType FLASH_256KB_1_INFRARED; // AFAIK, only "Active Health with Carol Vorderman" has such a flash save memory
const CardType FLASH_256KB_2_INFRARED;
const CardType FLASH_512KB_1_INFRARED;
const CardType FLASH_512KB_2_INFRARED;
int SPIWriteRead(CardType type, void* cmd, u32 cmdSize, void* answer, u32 answerSize, const void* data, u32 dataSize);
int SPIWaitWriteEnd(CardType type); int SPIWaitWriteEnd(CardType type);
int SPIEnableWriting(CardType type); int SPIEnableWriting(CardType type);
int SPIReadJEDECIDAndStatusReg(CardType type, u32* id, u8* statusReg); int SPIReadJEDECIDAndStatusReg(CardType type, u32* id, u8* statusReg);
int SPIGetCardType(CardType* type, int infrared); int SPIGetCardType(CardType* type, int infrared);
u32 SPIGetPageSize(CardType type); u32 SPIGetPageSize(CardType type);
u32 SPIGetCapacity(CardType type); u32 SPIGetCapacity(CardType type);
u32 SPIGetEraseSize(CardType type);
int SPIWriteSaveData(CardType type, u32 offset, const void* data, u32 size); int SPIWriteSaveData(CardType type, u32 offset, const void* data, u32 size);
int SPIReadSaveData(CardType type, u32 offset, void* data, u32 size); int SPIReadSaveData(CardType type, u32 offset, void* data, u32 size);
// int SPIEraseSector(CardType type, u32 offset); int SPIEraseSector(CardType type, u32 offset);
// int SPIErase(CardType type); int SPIErase(CardType type);
#ifdef __cplusplus #ifdef __cplusplus
} }

4
arm9/source/gamecart/spi_test.c
View File

@ -9,7 +9,7 @@ void SPITestWaitWriteEnd(CardType type) {
int SPITestEraseSector(CardType type, u32 offset, u8 actualCmd) { int SPITestEraseSector(CardType type, u32 offset, u8 actualCmd) {
u8 cmd[4] = { actualCmd, (u8)(offset >> 16), (u8)(offset >> 8), (u8) offset }; u8 cmd[4] = { actualCmd, (u8)(offset >> 16), (u8)(offset >> 8), (u8) offset };
if(type == NO_CHIP || type == FLASH_8MB) return 0xC8E13404; if(type == NO_CHIP) return 0xC8E13404;
int res = SPIWaitWriteEnd(type); int res = SPIWaitWriteEnd(type);
@ -57,7 +57,7 @@ int SPITestBytes(CardType t, u32 id, u8 *buf, u8 byte, const char *word, u32 siz
} }
void SPIFlashTest(void) { void SPIFlashTest(void) {
CardType t = ShowPrompt(true, "Does the cart have IR?") ? FLASH_512KB_INFRARED : FLASH_256KB_1; CardType t = ShowPrompt(true, "Does the cart have IR?") ? FLASH_512KB_1_INFRARED : FLASH_256KB_1;
u32 size; u32 size;
u32 pageSize; u32 pageSize;
u32 jedecid; u32 jedecid;