ShuriZma
/
dolphin
mirror of https://github.com/dolphin-emu/dolphin.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

EXI_DeviceMemoryCard: Fix member variable names

This commit is contained in:
Léo Lam 2020-11-20 19:07:21 +01:00
parent 1f15119f80
commit b2f00be637
No known key found for this signature in database
GPG Key ID: 0DF30F9081000741
2 changed files with 113 additions and 113 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

204
Source/Core/Core/HW/EXI/EXI_DeviceMemoryCard.cpp
View File

@ -108,7 +108,7 @@ void CEXIMemoryCard::Shutdown()
CEXIMemoryCard::CEXIMemoryCard(const int index, bool gci_folder, CEXIMemoryCard::CEXIMemoryCard(const int index, bool gci_folder,
const Memcard::HeaderData& header_data) const Memcard::HeaderData& header_data)
: card_index(index) : m_card_index(index)
{ {
ASSERT_MSG(EXPANSIONINTERFACE, static_cast<std::size_t>(index) < s_et_cmd_done.size(), ASSERT_MSG(EXPANSIONINTERFACE, static_cast<std::size_t>(index) < s_et_cmd_done.size(),
"Trying to create invalid memory card index %d.", index); "Trying to create invalid memory card index %d.", index);
@ -116,12 +116,12 @@ CEXIMemoryCard::CEXIMemoryCard(const int index, bool gci_folder,
// NOTE: When loading a save state, DMA completion callbacks (s_et_transfer_complete) and such // NOTE: When loading a save state, DMA completion callbacks (s_et_transfer_complete) and such
// may have been restored, we need to anticipate those arriving. // may have been restored, we need to anticipate those arriving.
interruptSwitch = 0; m_interrupt_switch = 0;
m_bInterruptSet = false; m_interrupt_set = false;
command = 0; m_command = 0;
status = MC_STATUS_BUSY | MC_STATUS_UNLOCKED | MC_STATUS_READY; m_status = MC_STATUS_BUSY | MC_STATUS_UNLOCKED | MC_STATUS_READY;
m_uPosition = 0; m_position = 0;
memset(programming_buffer, 0, sizeof(programming_buffer)); memset(m_programming_buffer, 0, sizeof(m_programming_buffer));
// Nintendo Memory Card EXI IDs // Nintendo Memory Card EXI IDs
// 0x00000004 Memory Card 59 4Mbit // 0x00000004 Memory Card 59 4Mbit
// 0x00000008 Memory Card 123 8Mb // 0x00000008 Memory Card 123 8Mb
@ -132,7 +132,7 @@ CEXIMemoryCard::CEXIMemoryCard(const int index, bool gci_folder,
// 0x00000510 16Mb "bigben" card // 0x00000510 16Mb "bigben" card
// card_id = 0xc243; // card_id = 0xc243;
card_id = 0xc221; // It's a Nintendo brand memcard m_card_id = 0xc221; // It's a Nintendo brand memcard
if (gci_folder) if (gci_folder)
{ {
@ -143,10 +143,10 @@ CEXIMemoryCard::CEXIMemoryCard(const int index, bool gci_folder,
SetupRawMemcard(header_data.m_size_mb); SetupRawMemcard(header_data.m_size_mb);
} }
memory_card_size = memorycard->GetCardId() * SIZE_TO_Mb; m_memory_card_size = m_memory_card->GetCardId() * SIZE_TO_Mb;
std::array<u8, 20> header{}; std::array<u8, 20> header{};
memorycard->Read(0, static_cast<s32>(header.size()), header.data()); m_memory_card->Read(0, static_cast<s32>(header.size()), header.data());
SetCardFlashID(header.data(), card_index); SetCardFlashID(header.data(), m_card_index);
} }
std::pair<std::string /* path */, bool /* migrate */> std::pair<std::string /* path */, bool /* migrate */>
@ -187,7 +187,7 @@ void CEXIMemoryCard::SetupGciFolder(const Memcard::HeaderData& header_data)
// TODO(C++20): Use structured bindings when we can use C++20 and refer to structured bindings // TODO(C++20): Use structured bindings when we can use C++20 and refer to structured bindings
// in lambda captures // in lambda captures
const auto folder_path_pair = GetGCIFolderPath(card_index, AllowMovieFolder::Yes); const auto folder_path_pair = GetGCIFolderPath(m_card_index, AllowMovieFolder::Yes);
const std::string& dir_path = folder_path_pair.first; const std::string& dir_path = folder_path_pair.first;
const bool migrate = folder_path_pair.second; const bool migrate = folder_path_pair.second;
@ -195,7 +195,7 @@ void CEXIMemoryCard::SetupGciFolder(const Memcard::HeaderData& header_data)
if (!file_info.Exists()) if (!file_info.Exists())
{ {
if (migrate) // first use of memcard folder, migrate automatically if (migrate) // first use of memcard folder, migrate automatically
MigrateFromMemcardFile(dir_path + DIR_SEP, card_index); MigrateFromMemcardFile(dir_path + DIR_SEP, m_card_index);
else else
File::CreateFullPath(dir_path + DIR_SEP); File::CreateFullPath(dir_path + DIR_SEP);
} }
@ -205,7 +205,7 @@ void CEXIMemoryCard::SetupGciFolder(const Memcard::HeaderData& header_data)
{ {
PanicAlertFmtT("{0} was not a directory, moved to *.original", dir_path); PanicAlertFmtT("{0} was not a directory, moved to *.original", dir_path);
if (migrate) if (migrate)
MigrateFromMemcardFile(dir_path + DIR_SEP, card_index); MigrateFromMemcardFile(dir_path + DIR_SEP, m_card_index);
else else
File::CreateFullPath(dir_path + DIR_SEP); File::CreateFullPath(dir_path + DIR_SEP);
} }
@ -219,16 +219,16 @@ void CEXIMemoryCard::SetupGciFolder(const Memcard::HeaderData& header_data)
} }
} }
memorycard = std::make_unique<GCMemcardDirectory>(dir_path + DIR_SEP, card_index, header_data, m_memory_card = std::make_unique<GCMemcardDirectory>(dir_path + DIR_SEP, m_card_index,
current_game_id); header_data, current_game_id);
} }
void CEXIMemoryCard::SetupRawMemcard(u16 size_mb) void CEXIMemoryCard::SetupRawMemcard(u16 size_mb)
{ {
const bool is_slot_a = card_index == 0; const bool is_slot_a = m_card_index == 0;
std::string filename = is_slot_a ? Config::Get(Config::MAIN_MEMCARD_A_PATH) : std::string filename = is_slot_a ? Config::Get(Config::MAIN_MEMCARD_A_PATH) :
Config::Get(Config::MAIN_MEMCARD_B_PATH); Config::Get(Config::MAIN_MEMCARD_B_PATH);
if (Movie::IsPlayingInput() && Movie::IsConfigSaved() && Movie::IsUsingMemcard(card_index) && if (Movie::IsPlayingInput() && Movie::IsConfigSaved() && Movie::IsUsingMemcard(m_card_index) &&
Movie::IsStartingFromClearSave()) Movie::IsStartingFromClearSave())
filename = File::GetUserPath(D_GCUSER_IDX) + fmt::format("Movie{}.raw", is_slot_a ? 'A' : 'B'); filename = File::GetUserPath(D_GCUSER_IDX) + fmt::format("Movie{}.raw", is_slot_a ? 'A' : 'B');
@ -239,13 +239,13 @@ void CEXIMemoryCard::SetupRawMemcard(u16 size_mb)
if (size_mb == Memcard::MBIT_SIZE_MEMORY_CARD_251) if (size_mb == Memcard::MBIT_SIZE_MEMORY_CARD_251)
filename.insert(filename.find_last_of('.'), ".251"); filename.insert(filename.find_last_of('.'), ".251");
memorycard = std::make_unique<MemoryCard>(filename, card_index, size_mb); m_memory_card = std::make_unique<MemoryCard>(filename, m_card_index, size_mb);
} }
CEXIMemoryCard::~CEXIMemoryCard() CEXIMemoryCard::~CEXIMemoryCard()
{ {
CoreTiming::RemoveEvent(s_et_cmd_done[card_index]); CoreTiming::RemoveEvent(s_et_cmd_done[m_card_index]);
CoreTiming::RemoveEvent(s_et_transfer_complete[card_index]); CoreTiming::RemoveEvent(s_et_transfer_complete[m_card_index]);
} }
bool CEXIMemoryCard::UseDelayedTransferCompletion() const bool CEXIMemoryCard::UseDelayedTransferCompletion() const
@ -260,41 +260,41 @@ bool CEXIMemoryCard::IsPresent() const
void CEXIMemoryCard::CmdDone() void CEXIMemoryCard::CmdDone()
{ {
status |= MC_STATUS_READY; m_status |= MC_STATUS_READY;
status &= ~MC_STATUS_BUSY; m_status &= ~MC_STATUS_BUSY;
m_bInterruptSet = true; m_interrupt_set = true;
ExpansionInterface::UpdateInterrupts(); ExpansionInterface::UpdateInterrupts();
} }
void CEXIMemoryCard::TransferComplete() void CEXIMemoryCard::TransferComplete()
{ {
// Transfer complete, send interrupt // Transfer complete, send interrupt
ExpansionInterface::GetChannel(card_index)->SendTransferComplete(); ExpansionInterface::GetChannel(m_card_index)->SendTransferComplete();
} }
void CEXIMemoryCard::CmdDoneLater(u64 cycles) void CEXIMemoryCard::CmdDoneLater(u64 cycles)
{ {
CoreTiming::RemoveEvent(s_et_cmd_done[card_index]); CoreTiming::RemoveEvent(s_et_cmd_done[m_card_index]);
CoreTiming::ScheduleEvent(cycles, s_et_cmd_done[card_index], card_index); CoreTiming::ScheduleEvent(cycles, s_et_cmd_done[m_card_index], m_card_index);
} }
void CEXIMemoryCard::SetCS(int cs) void CEXIMemoryCard::SetCS(int cs)
{ {
if (cs) // not-selected to selected if (cs) // not-selected to selected
{ {
m_uPosition = 0; m_position = 0;
} }
else else
{ {
switch (command) switch (m_command)
{ {
case cmdSectorErase: case cmdSectorErase:
if (m_uPosition > 2) if (m_position > 2)
{ {
memorycard->ClearBlock(address & (memory_card_size - 1)); m_memory_card->ClearBlock(m_address & (m_memory_card_size - 1));
status |= MC_STATUS_BUSY; m_status |= MC_STATUS_BUSY;
status &= ~MC_STATUS_READY; m_status &= ~MC_STATUS_READY;
//??? //???
@ -303,27 +303,27 @@ void CEXIMemoryCard::SetCS(int cs)
break; break;
case cmdChipErase: case cmdChipErase:
if (m_uPosition > 2) if (m_position > 2)
{ {
// TODO: Investigate on HW, I (LPFaint99) believe that this only // TODO: Investigate on HW, I (LPFaint99) believe that this only
// erases the system area (Blocks 0-4) // erases the system area (Blocks 0-4)
memorycard->ClearAll(); m_memory_card->ClearAll();
status &= ~MC_STATUS_BUSY; m_status &= ~MC_STATUS_BUSY;
} }
break; break;
case cmdPageProgram: case cmdPageProgram:
if (m_uPosition >= 5) if (m_position >= 5)
{ {
int count = m_uPosition - 5; int count = m_position - 5;
int i = 0; int i = 0;
status &= ~MC_STATUS_BUSY; m_status &= ~MC_STATUS_BUSY;
while (count--) while (count--)
{ {
memorycard->Write(address, 1, &(programming_buffer[i++])); m_memory_card->Write(m_address, 1, &(m_programming_buffer[i++]));
i &= 127; i &= 127;
address = (address & ~0x1FF) | ((address + 1) & 0x1FF); m_address = (m_address & ~0x1FF) | ((m_address + 1) & 0x1FF);
} }
CmdDoneLater(5000); CmdDoneLater(5000);
@ -335,20 +335,20 @@ void CEXIMemoryCard::SetCS(int cs)
bool CEXIMemoryCard::IsInterruptSet() bool CEXIMemoryCard::IsInterruptSet()
{ {
if (interruptSwitch) if (m_interrupt_switch)
return m_bInterruptSet; return m_interrupt_set;
return false; return false;
} }
void CEXIMemoryCard::TransferByte(u8& byte) void CEXIMemoryCard::TransferByte(u8& byte)
{ {
DEBUG_LOG_FMT(EXPANSIONINTERFACE, "EXI MEMCARD: > {:02x}", byte); DEBUG_LOG_FMT(EXPANSIONINTERFACE, "EXI MEMCARD: > {:02x}", byte);
if (m_uPosition == 0) if (m_position == 0)
{ {
command = byte; // first byte is command m_command = byte; // first byte is command
byte = 0xFF; // would be tristate, but we don't care. byte = 0xFF; // would be tristate, but we don't care.
switch (command) // This seems silly, do we really need it? switch (m_command) // This seems silly, do we really need it?
{ {
case cmdNintendoID: case cmdNintendoID:
case cmdReadArray: case cmdReadArray:
@ -366,28 +366,28 @@ void CEXIMemoryCard::TransferByte(u8& byte)
case cmdExtraByteProgram: case cmdExtraByteProgram:
case cmdChipErase: case cmdChipErase:
DEBUG_LOG_FMT(EXPANSIONINTERFACE, "EXI MEMCARD: command {:02x} at position 0. seems normal.", DEBUG_LOG_FMT(EXPANSIONINTERFACE, "EXI MEMCARD: command {:02x} at position 0. seems normal.",
command); m_command);
break; break;
default: default:
WARN_LOG_FMT(EXPANSIONINTERFACE, "EXI MEMCARD: command {:02x} at position 0", command); WARN_LOG_FMT(EXPANSIONINTERFACE, "EXI MEMCARD: command {:02x} at position 0", m_command);
break; break;
} }
if (command == cmdClearStatus) if (m_command == cmdClearStatus)
{ {
status &= ~MC_STATUS_PROGRAMEERROR; m_status &= ~MC_STATUS_PROGRAMEERROR;
status &= ~MC_STATUS_ERASEERROR; m_status &= ~MC_STATUS_ERASEERROR;
status |= MC_STATUS_READY; m_status |= MC_STATUS_READY;
m_bInterruptSet = false; m_interrupt_set = false;
byte = 0xFF; byte = 0xFF;
m_uPosition = 0; m_position = 0;
} }
} }
else else
{ {
switch (command) switch (m_command)
{ {
case cmdNintendoID: case cmdNintendoID:
// //
@ -396,68 +396,68 @@ void CEXIMemoryCard::TransferByte(u8& byte)
// "bigben" card: // "bigben" card:
// 00 | ff 00 00 05 10 00 00 00 00 00 00 00 00 00 00 // 00 | ff 00 00 05 10 00 00 00 00 00 00 00 00 00 00
// we do it the Nintendo way. // we do it the Nintendo way.
if (m_uPosition == 1) if (m_position == 1)
byte = 0x80; // dummy cycle byte = 0x80; // dummy cycle
else else
byte = static_cast<u8>(memorycard->GetCardId() >> (24 - (((m_uPosition - 2) & 3) * 8))); byte = static_cast<u8>(m_memory_card->GetCardId() >> (24 - (((m_position - 2) & 3) * 8)));
break; break;
case cmdReadArray: case cmdReadArray:
switch (m_uPosition) switch (m_position)
{ {
case 1: // AD1 case 1: // AD1
address = byte << 17; m_address = byte << 17;
byte = 0xFF; byte = 0xFF;
break; break;
case 2: // AD2 case 2: // AD2
address |= byte << 9; m_address |= byte << 9;
break; break;
case 3: // AD3 case 3: // AD3
address |= (byte & 3) << 7; m_address |= (byte & 3) << 7;
break; break;
case 4: // BA case 4: // BA
address |= (byte & 0x7F); m_address |= (byte & 0x7F);
break; break;
} }
if (m_uPosition > 1) // not specified for 1..8, anyway if (m_position > 1) // not specified for 1..8, anyway
{ {
memorycard->Read(address & (memory_card_size - 1), 1, &byte); m_memory_card->Read(m_address & (m_memory_card_size - 1), 1, &byte);
// after 9 bytes, we start incrementing the address, // after 9 bytes, we start incrementing the address,
// but only the sector offset - the pointer wraps around // but only the sector offset - the pointer wraps around
if (m_uPosition >= 9) if (m_position >= 9)
address = (address & ~0x1FF) | ((address + 1) & 0x1FF); m_address = (m_address & ~0x1FF) | ((m_address + 1) & 0x1FF);
} }
break; break;
case cmdReadStatus: case cmdReadStatus:
// (unspecified for byte 1) // (unspecified for byte 1)
byte = status; byte = m_status;
break; break;
case cmdReadID: case cmdReadID:
if (m_uPosition == 1) // (unspecified) if (m_position == 1) // (unspecified)
byte = static_cast<u8>(card_id >> 8); byte = static_cast<u8>(m_card_id >> 8);
else else
byte = static_cast<u8>((m_uPosition & 1) ? (card_id) : (card_id >> 8)); byte = static_cast<u8>((m_position & 1) ? (m_card_id) : (m_card_id >> 8));
break; break;
case cmdSectorErase: case cmdSectorErase:
switch (m_uPosition) switch (m_position)
{ {
case 1: // AD1 case 1: // AD1
address = byte << 17; m_address = byte << 17;
break; break;
case 2: // AD2 case 2: // AD2
address |= byte << 9; m_address |= byte << 9;
break; break;
} }
byte = 0xFF; byte = 0xFF;
break; break;
case cmdSetInterrupt: case cmdSetInterrupt:
if (m_uPosition == 1) if (m_position == 1)
{ {
interruptSwitch = byte; m_interrupt_switch = byte;
} }
byte = 0xFF; byte = 0xFF;
break; break;
@ -467,24 +467,24 @@ void CEXIMemoryCard::TransferByte(u8& byte)
break; break;
case cmdPageProgram: case cmdPageProgram:
switch (m_uPosition) switch (m_position)
{ {
case 1: // AD1 case 1: // AD1
address = byte << 17; m_address = byte << 17;
break; break;
case 2: // AD2 case 2: // AD2
address |= byte << 9; m_address |= byte << 9;
break; break;
case 3: // AD3 case 3: // AD3
address |= (byte & 3) << 7; m_address |= (byte & 3) << 7;
break; break;
case 4: // BA case 4: // BA
address |= (byte & 0x7F); m_address |= (byte & 0x7F);
break; break;
} }
if (m_uPosition >= 5) if (m_position >= 5)
programming_buffer[((m_uPosition - 5) & 0x7F)] = byte; // wrap around after 128 bytes m_programming_buffer[((m_position - 5) & 0x7F)] = byte; // wrap around after 128 bytes
byte = 0xFF; byte = 0xFF;
break; break;
@ -494,7 +494,7 @@ void CEXIMemoryCard::TransferByte(u8& byte)
byte = 0xFF; byte = 0xFF;
} }
} }
m_uPosition++; m_position++;
DEBUG_LOG_FMT(EXPANSIONINTERFACE, "EXI MEMCARD: < {:02x}", byte); DEBUG_LOG_FMT(EXPANSIONINTERFACE, "EXI MEMCARD: < {:02x}", byte);
} }
@ -509,15 +509,15 @@ void CEXIMemoryCard::DoState(PointerWrap& p)
if (storeContents) if (storeContents)
{ {
p.Do(interruptSwitch); p.Do(m_interrupt_switch);
p.Do(m_bInterruptSet); p.Do(m_interrupt_set);
p.Do(command); p.Do(m_command);
p.Do(status); p.Do(m_status);
p.Do(m_uPosition); p.Do(m_position);
p.Do(programming_buffer); p.Do(m_programming_buffer);
p.Do(address); p.Do(m_address);
memorycard->DoState(p); m_memory_card->DoState(p);
p.Do(card_index); p.Do(m_card_index);
} }
} }
@ -525,7 +525,7 @@ IEXIDevice* CEXIMemoryCard::FindDevice(TEXIDevices device_type, int custom_index
{ {
if (device_type != m_device_type) if (device_type != m_device_type)
return nullptr; return nullptr;
if (custom_index != card_index) if (custom_index != m_card_index)
return nullptr; return nullptr;
return this; return this;
} }
@ -534,31 +534,31 @@ IEXIDevice* CEXIMemoryCard::FindDevice(TEXIDevices device_type, int custom_index
// read all at once instead of single byte at a time as done by IEXIDevice::DMARead // read all at once instead of single byte at a time as done by IEXIDevice::DMARead
void CEXIMemoryCard::DMARead(u32 addr, u32 size) void CEXIMemoryCard::DMARead(u32 addr, u32 size)
{ {
memorycard->Read(address, size, Memory::GetPointer(addr)); m_memory_card->Read(m_address, size, Memory::GetPointer(addr));
if ((address + size) % Memcard::BLOCK_SIZE == 0) if ((m_address + size) % Memcard::BLOCK_SIZE == 0)
{ {
INFO_LOG_FMT(EXPANSIONINTERFACE, "reading from block: {:x}", address / Memcard::BLOCK_SIZE); INFO_LOG_FMT(EXPANSIONINTERFACE, "reading from block: {:x}", m_address / Memcard::BLOCK_SIZE);
} }
// Schedule transfer complete later based on read speed // Schedule transfer complete later based on read speed
CoreTiming::ScheduleEvent(size * (SystemTimers::GetTicksPerSecond() / MC_TRANSFER_RATE_READ), CoreTiming::ScheduleEvent(size * (SystemTimers::GetTicksPerSecond() / MC_TRANSFER_RATE_READ),
s_et_transfer_complete[card_index], card_index); s_et_transfer_complete[m_card_index], m_card_index);
} }
// DMA write are preceded by all of the necessary setup via IMMWrite // DMA write are preceded by all of the necessary setup via IMMWrite
// write all at once instead of single byte at a time as done by IEXIDevice::DMAWrite // write all at once instead of single byte at a time as done by IEXIDevice::DMAWrite
void CEXIMemoryCard::DMAWrite(u32 addr, u32 size) void CEXIMemoryCard::DMAWrite(u32 addr, u32 size)
{ {
memorycard->Write(address, size, Memory::GetPointer(addr)); m_memory_card->Write(m_address, size, Memory::GetPointer(addr));
if (((address + size) % Memcard::BLOCK_SIZE) == 0) if (((m_address + size) % Memcard::BLOCK_SIZE) == 0)
{ {
INFO_LOG_FMT(EXPANSIONINTERFACE, "writing to block: {:x}", address / Memcard::BLOCK_SIZE); INFO_LOG_FMT(EXPANSIONINTERFACE, "writing to block: {:x}", m_address / Memcard::BLOCK_SIZE);
} }
// Schedule transfer complete later based on write speed // Schedule transfer complete later based on write speed
CoreTiming::ScheduleEvent(size * (SystemTimers::GetTicksPerSecond() / MC_TRANSFER_RATE_WRITE), CoreTiming::ScheduleEvent(size * (SystemTimers::GetTicksPerSecond() / MC_TRANSFER_RATE_WRITE),
s_et_transfer_complete[card_index], card_index); s_et_transfer_complete[m_card_index], m_card_index);
} }
} // namespace ExpansionInterface } // namespace ExpansionInterface

22
Source/Core/Core/HW/EXI/EXI_DeviceMemoryCard.h
View File

@ -90,21 +90,21 @@ private:
cmdChipErase = 0xF4, cmdChipErase = 0xF4,
}; };
int card_index; int m_card_index;
//! memory card state //! memory card state
// STATE_TO_SAVE // STATE_TO_SAVE
int interruptSwitch; int m_interrupt_switch;
bool m_bInterruptSet; bool m_interrupt_set;
int command; int m_command;
int status; int m_status;
u32 m_uPosition; u32 m_position;
u8 programming_buffer[128]; u8 m_programming_buffer[128];
//! memory card parameters //! memory card parameters
unsigned int card_id; unsigned int m_card_id;
unsigned int address; unsigned int m_address;
u32 memory_card_size; u32 m_memory_card_size;
std::unique_ptr<MemoryCardBase> memorycard; std::unique_ptr<MemoryCardBase> m_memory_card;
protected: protected:
void TransferByte(u8& byte) override; void TransferByte(u8& byte) override;