project64/Source/Project64-core/N64System/MemoryHandler/PifRamHandler.cpp

#include "stdafx.h"

#include "PifRamHandler.h"
#include <Project64-core/Debugger.h>
#include <Project64-core/N64System/Mips/MemoryVirtualMem.h>
#include <Project64-core/N64System/Mips/Rumblepak.h>
#include <Project64-core/N64System/Mips/Transferpak.h>
#include <Project64-core/N64System/SystemGlobals.h>
#include <Project64-core/N64System/N64System.h>

PifRamHandler::PifRamHandler(CN64System & System, bool SavesReadOnly) :
    m_MMU(System.m_MMU_VM),
    m_PC(System.m_Reg.m_PROGRAM_COUNTER),
    m_Eeprom(SavesReadOnly)
{
    SystemReset();

    System.RegisterCallBack(CN64SystemCB_Reset, this, (CN64System::CallBackFunction)stSystemReset);
}

bool PifRamHandler::Read32(uint32_t Address, uint32_t & Value)
{
    Address &= 0x1FFFFFFF;
    if (Address < 0x1FC007C0)
    {
        //Value = swap32by8(*(uint32_t *)(&PifRom[PAddr - 0x1FC00000]));
        Value = 0;
        if (HaveDebugger())
        {
            g_Notify->BreakPoint(__FILE__, __LINE__);
        }
    }
    else if (Address < 0x1FC00800)
    {
        Value = *(uint32_t *)(&m_PifRam[Address - 0x1FC007C0]);
        Value = swap32by8(Value);
    }
    else
    {
        Value = 0;
        if (HaveDebugger())
        {
            g_Notify->BreakPoint(__FILE__, __LINE__);
        }
    }

    if (GenerateLog() && LogPRDirectMemLoads() && Address >= 0x1FC007C0 && Address <= 0x1FC007FC)
    {
        LogMessage("%08X: read word from PIF RAM at 0x%X (%08X)", m_PC, Address - 0x1FC007C0, Value);
    }
    return true;
}

bool PifRamHandler::Write32(uint32_t Address, uint32_t Value, uint32_t Mask)
{
    Address &= 0x1FFFFFFF;
    if (GenerateLog() && LogPRDirectMemStores() && Address >= 0x1FC007C0 && Address <= 0x1FC007FC)
    {
        LogMessage("%08X: Writing 0x%08X to PIF RAM at 0x%X", m_PC, Value, Address - 0x1FC007C0);
    }

    if (Address < 0x1FC007C0)
    {
        //Write to pif rom ignored
    }
    else if (Address < 0x1FC00800)
    {
        uint32_t SwappedMask = swap32by8(Mask);
        Value = ((*(uint32_t *)(&m_PifRam[Address - 0x1FC007C0])) & ~SwappedMask) | (swap32by8(Value) & SwappedMask);
        *(uint32_t *)(&m_PifRam[Address - 0x1FC007C0]) = Value;
        if (Address == 0x1FC007FC)
        {
            ControlWrite();
        }
    }
    return true;
}

void PifRamHandler::DMA_READ()
{
    uint8_t * PifRamPos = m_PifRam;
    uint8_t * RDRAM = g_MMU->Rdram();

    uint32_t & SI_DRAM_ADDR_REG = (uint32_t &)g_Reg->SI_DRAM_ADDR_REG;
    if ((int32_t)SI_DRAM_ADDR_REG > (int32_t)g_System->RdramSize())
    {
        if (bShowPifRamErrors())
        {
            g_Notify->DisplayError(stdstr_f("%s\nSI_DRAM_ADDR_REG not in RDRAM space", __FUNCTION__).c_str());
        }
        return;
    }

    ControlRead();

    if (CDebugSettings::HaveDebugger())
    {
        g_Debugger->PIFReadStarted();
    }

    SI_DRAM_ADDR_REG &= 0xFFFFFFF8;
    if ((int32_t)SI_DRAM_ADDR_REG < 0)
    {
        int32_t count, RdramPos;

        RdramPos = (int32_t)SI_DRAM_ADDR_REG;
        for (count = 0; count < 0x40; count++, RdramPos++)
        {
            if (RdramPos < 0)
            {
                continue;
            }
            RDRAM[RdramPos ^ 3] = m_PifRam[count];
        }
    }
    else
    {
        for (size_t i = 0; i < 64; i++)
        {
            RDRAM[(SI_DRAM_ADDR_REG + i) ^ 3] = PifRamPos[i];
        }
    }

    if (LogPRDMAMemStores())
    {
        int32_t count;
        char HexData[100], AsciiData[100], Addon[20];
        LogMessage("\tData DMAed to RDRAM:");
        LogMessage("\t--------------------");
        for (count = 0; count < 16; count++)
        {
            if ((count % 4) == 0)
            {
                HexData[0] = '\0';
                AsciiData[0] = '\0';
            }
            sprintf(Addon, "%02X %02X %02X %02X",
                m_PifRam[(count << 2) + 0], m_PifRam[(count << 2) + 1],
                m_PifRam[(count << 2) + 2], m_PifRam[(count << 2) + 3]);
            strcat(HexData, Addon);
            if (((count + 1) % 4) != 0)
            {
                sprintf(Addon, "-");
                strcat(HexData, Addon);
            }

            sprintf(Addon, "%c%c%c%c",
                m_PifRam[(count << 2) + 0], m_PifRam[(count << 2) + 1],
                m_PifRam[(count << 2) + 2], m_PifRam[(count << 2) + 3]);
            strcat(AsciiData, Addon);

            if (((count + 1) % 4) == 0)
            {
                LogMessage("\t%s %s", HexData, AsciiData);
            }
        }
        LogMessage("");
    }

    if (g_System->bRandomizeSIPIInterrupts())
    {
        if (g_System->bDelaySI())
        {
            g_SystemTimer->SetTimer(CSystemTimer::SiTimer, 0x900 + (g_Random->next() % 0x40), false);
        }
        else
        {
            g_SystemTimer->SetTimer(CSystemTimer::SiTimer, g_Random->next() % 0x40, false);
        }
    }
    else
    {
        if (g_System->bDelaySI())
        {
            g_SystemTimer->SetTimer(CSystemTimer::SiTimer, 0x900, false);
        }
        else
        {
            g_Reg->MI_INTR_REG |= MI_INTR_SI;
            g_Reg->SI_STATUS_REG |= SI_STATUS_INTERRUPT;
            g_Reg->CheckInterrupts();
        }
    }
}

void PifRamHandler::DMA_WRITE()
{
    uint8_t * PifRamPos = m_PifRam;

    uint32_t & SI_DRAM_ADDR_REG = (uint32_t &)g_Reg->SI_DRAM_ADDR_REG;
    if ((int32_t)SI_DRAM_ADDR_REG > (int32_t)g_System->RdramSize())
    {
        if (bShowPifRamErrors())
        {
            g_Notify->DisplayError("SI DMA\nSI_DRAM_ADDR_REG not in RDRAM space");
        }
        return;
    }

    SI_DRAM_ADDR_REG &= 0xFFFFFFF8;
    uint8_t * RDRAM = g_MMU->Rdram();

    if ((int32_t)SI_DRAM_ADDR_REG < 0)
    {
        int32_t RdramPos = (int32_t)SI_DRAM_ADDR_REG;

        for (int32_t count = 0; count < 0x40; count++, RdramPos++)
        {
            if (RdramPos < 0)
            {
                m_PifRam[count] = 0;
                continue;
            }
            m_PifRam[count] = RDRAM[RdramPos ^ 3];
        }
    }
    else
    {
        for (size_t i = 0; i < 64; i++)
        {
            PifRamPos[i] = RDRAM[(SI_DRAM_ADDR_REG + i) ^ 3];
        }
    }

    if (LogPRDMAMemLoads())
    {
        int32_t count;
        char HexData[100], AsciiData[100], Addon[20];
        LogMessage("");
        LogMessage("\tData DMAed to the PIF RAM:");
        LogMessage("\t--------------------------");
        for (count = 0; count < 16; count++)
        {
            if ((count % 4) == 0)
            {
                HexData[0] = '\0';
                AsciiData[0] = '\0';
            }
            sprintf(Addon, "%02X %02X %02X %02X",
                m_PifRam[(count << 2) + 0], m_PifRam[(count << 2) + 1],
                m_PifRam[(count << 2) + 2], m_PifRam[(count << 2) + 3]);
            strcat(HexData, Addon);
            if (((count + 1) % 4) != 0)
            {
                sprintf(Addon, "-");
                strcat(HexData, Addon);
            }

            sprintf(Addon, "%c%c%c%c",
                m_PifRam[(count << 2) + 0], m_PifRam[(count << 2) + 1],
                m_PifRam[(count << 2) + 2], m_PifRam[(count << 2) + 3]);
            strcat(AsciiData, Addon);

            if (((count + 1) % 4) == 0)
            {
                LogMessage("\t%s %s", HexData, AsciiData);
            }
        }
        LogMessage("");
    }

    ControlWrite();

    if (g_System->bDelaySI())
    {
        g_SystemTimer->SetTimer(CSystemTimer::SiTimer, 0x900, false);
    }
    else
    {
        g_Reg->MI_INTR_REG |= MI_INTR_SI;
        g_Reg->SI_STATUS_REG |= SI_STATUS_INTERRUPT;
        g_Reg->CheckInterrupts();
    }
}

void PifRamHandler::CicNus6105(const char * Challenge, char * Respone, int32_t Length)
{
    // clang-format off
    static const char lut0[0x10] = {
        0x4, 0x7, 0xA, 0x7, 0xE, 0x5, 0xE, 0x1,
        0xC, 0xF, 0x8, 0xF, 0x6, 0x3, 0x6, 0x9,
    };
    static const char lut1[0x10] = {
        0x4, 0x1, 0xA, 0x7, 0xE, 0x5, 0xE, 0x1,
        0xC, 0x9, 0x8, 0x5, 0x6, 0x3, 0xC, 0x9,
    };
    // clang-format on
    const char * lut = lut0;
    char Key = 0xB;

    for (int32_t i = 0; i < Length; i++)
    {
        Respone[i] = (Key + 5 * Challenge[i]) & 0xF;
        Key = lut[Respone[i]];
        int32_t Sgn = (Respone[i] >> 3) & 0x1;
        int32_t Mag = ((Sgn == 1) ? ~Respone[i] : Respone[i]) & 0x7;
        int32_t Mod = (Mag % 3 == 1) ? Sgn : 1 - Sgn;
        if (lut == lut1 && (Respone[i] == 0x1 || Respone[i] == 0x9))
        {
            Mod = 1;
        }
        if (lut == lut1 && (Respone[i] == 0xB || Respone[i] == 0xE))
        {
            Mod = 0;
        }
        lut = (Mod == 1) ? lut1 : lut0;
    }
}

void PifRamHandler::ControlRead()
{
    if (m_PifRam[0x3F] == 0x2)
    {
        return;
    }

    CONTROL * Controllers = g_Plugins->Control()->PluginControllers();

    int32_t Channel = 0;
    for (int32_t CurPos = 0; CurPos < 0x40; CurPos++)
    {
        switch (m_PifRam[CurPos])
        {
        case 0x00:
            Channel += 1;
            if (Channel > 6)
            {
                CurPos = 0x40;
            }
            break;
        case 0xFD: CurPos = 0x40; break;
        case 0xFE: CurPos = 0x40; break;
        case 0xFF:
        case 0xB4:
        case 0x56:
        case 0xB8:
            break;
        default:
            if ((m_PifRam[CurPos] & 0xC0) == 0)
            {
                if (Channel < 4)
                {
                    if (Controllers[Channel].Present && Controllers[Channel].RawData)
                    {
                        if (g_Plugins->Control()->ReadController)
                        {
                            g_Plugins->Control()->ReadController(Channel, &m_PifRam[CurPos]);
                        }
                    }
                    else
                    {
                        ReadControllerCommand(Channel, &m_PifRam[CurPos]);
                    }
                }
                CurPos += m_PifRam[CurPos] + (m_PifRam[CurPos + 1] & 0x3F) + 1;
                Channel += 1;
            }
            else
            {
                if (CurPos != 0x27 && bShowPifRamErrors())
                {
                    g_Notify->DisplayError(stdstr_f("Unknown command in PifRamRead(%X)", m_PifRam[CurPos]).c_str());
                }
                CurPos = 0x40;
            }
            break;
        }
    }
    if (g_Plugins->Control()->ReadController)
    {
        g_Plugins->Control()->ReadController(-1, nullptr);
    }
}

void PifRamHandler::ControlWrite()
{
    enum
    {
        CHALLENGE_LENGTH = 0x20
    };

    CONTROL * Controllers = g_Plugins->Control()->PluginControllers();
    int32_t Channel = 0, CurPos;

    if (m_PifRam[0x3F] > 0x1)
    {
        switch (m_PifRam[0x3F])
        {
        case 0x02:
        {
            // Format the 'challenge' message into 30 nibbles for X-Scale's CIC code
            char Challenge[30], Response[30];
            for (int32_t i = 0; i < 15; i++)
            {
                Challenge[i * 2] = (m_PifRam[48 + i] >> 4) & 0x0f;
                Challenge[i * 2 + 1] = m_PifRam[48 + i] & 0x0f;
            }
            CicNus6105(Challenge, Response, CHALLENGE_LENGTH - 2);
            uint64_t ResponseValue = 0;
            m_PifRam[46] = m_PifRam[47] = 0x00;
            for (int32_t z = 8; z > 0; z--)
            {
                ResponseValue = (ResponseValue << 8) | ((Response[(z - 1) * 2] << 4) + Response[(z - 1) * 2 + 1]);
            }
            memcpy(&m_PifRam[48], &ResponseValue, sizeof(uint64_t));
            ResponseValue = 0;
            for (int32_t z = 7; z > 0; z--)
            {
                ResponseValue = (ResponseValue << 8) | ((Response[((z + 8) - 1) * 2] << 4) + Response[((z + 8) - 1) * 2 + 1]);
            }
            memcpy(&m_PifRam[56], &ResponseValue, sizeof(uint64_t));
            break;
        }
        case 0x08:
            m_PifRam[0x3F] = 0;
            g_Reg->MI_INTR_REG |= MI_INTR_SI;
            g_Reg->SI_STATUS_REG |= SI_STATUS_INTERRUPT;
            g_Reg->CheckInterrupts();
            break;
        case 0x10:
            memset(m_PifRom, 0, 0x7C0);
            break;
        case 0x30:
            m_PifRam[0x3F] = 0x80;
            break;
        case 0xC0:
            memset(m_PifRam, 0, 0x40);
            break;
        default:
            if (bShowPifRamErrors())
            {
                g_Notify->DisplayError(stdstr_f("Unknown PifRam control: %d", m_PifRam[0x3F]).c_str());
            }
        }
        return;
    }

    for (CurPos = 0; CurPos < 0x40; CurPos++)
    {
        switch (m_PifRam[CurPos])
        {
        case 0x00:
            Channel += 1;
            if (Channel > 6)
            {
                CurPos = 0x40;
            }
            break;
        case 0xFD: CurPos = 0x40; break;
        case 0xFE: CurPos = 0x40; break;
        case 0xFF:
        case 0xB4:
        case 0x56:
        case 0xB8:
            break;
        default:
            if ((m_PifRam[CurPos] & 0xC0) == 0)
            {
                if (Channel < 4)
                {
                    if (Controllers[Channel].Present && Controllers[Channel].RawData)
                    {
                        if (g_Plugins->Control()->ControllerCommand)
                        {
                            g_Plugins->Control()->ControllerCommand(Channel, &m_PifRam[CurPos]);
                        }
                    }
                    else
                    {
                        ProcessControllerCommand(Channel, &m_PifRam[CurPos]);
                    }
                }
                else if (Channel == 4)
                {
                    m_Eeprom.EepromCommand(&m_PifRam[CurPos]);
                }
                else
                {
                    if (bShowPifRamErrors())
                    {
                        g_Notify->DisplayError("Command on channel 5?");
                    }
                }
                CurPos += m_PifRam[CurPos] + (m_PifRam[CurPos + 1] & 0x3F) + 1;
                Channel += 1;
            }
            else
            {
                if (CurPos != 0x27 && bShowPifRamErrors())
                {
                    g_Notify->DisplayError(stdstr_f("Unknown Command in PifRamWrite(%X)", m_PifRam[CurPos]).c_str());
                }
                CurPos = 0x40;
            }
            break;
        }
    }
    m_PifRam[0x3F] = 0;
    if (g_Plugins->Control()->ControllerCommand)
    {
        g_Plugins->Control()->ControllerCommand(-1, nullptr);
    }
}

void PifRamHandler::LogControllerPakData(const char * Description)
{
    int32_t count, count2;
    char HexData[100], AsciiData[100], Addon[20];
    LogMessage("\t%s:", Description);
    LogMessage("\t------------------------------");
    for (count = 0; count < 16; count++)
    {
        if ((count % 4) == 0)
        {
            HexData[0] = '\0';
            AsciiData[0] = '\0';
        }
        sprintf(Addon, "%02X %02X %02X %02X",
            m_PifRam[(count << 2) + 0], m_PifRam[(count << 2) + 1],
            m_PifRam[(count << 2) + 2], m_PifRam[(count << 2) + 3]);
        strcat(HexData, Addon);
        if (((count + 1) % 4) != 0)
        {
            sprintf(Addon, "-");
            strcat(HexData, Addon);
        }

        Addon[0] = 0;
        for (count2 = 0; count2 < 4; count2++)
        {
            if (m_PifRam[(count << 2) + count2] < 30)
            {
                strcat(Addon, ".");
            }
            else
            {
                char tmp[2];
                sprintf(tmp, "%c", m_PifRam[(count << 2) + count2]);
                strcat(Addon, tmp);
            }
        }
        strcat(AsciiData, Addon);

        if (((count + 1) % 4) == 0)
        {
            LogMessage("\t%s %s", HexData, AsciiData);
        }
    }
    LogMessage("");
}

void PifRamHandler::ReadControllerCommand(int32_t Control, uint8_t * Command)
{
    CONTROL * Controllers = g_Plugins->Control()->PluginControllers();

    switch (Command[2])
    {
    case 0x01: // Read controller
        if (Controllers[Control].Present != PRESENT_NONE)
        {
            if (bShowPifRamErrors())
            {
                if (Command[0] != 1 || Command[1] != 4)
                {
                    g_Notify->DisplayError("What am I meant to do with this controller command?");
                }
            }

            const uint32_t buttons = g_BaseSystem->GetButtons(Control);
            memcpy(&Command[3], &buttons, sizeof(uint32_t));
        }
        break;
    case 0x02: // Read from controller pak
        if (Controllers[Control].Present != PRESENT_NONE)
        {
            switch (Controllers[Control].Plugin)
            {
            case PLUGIN_RAW:
                if (g_Plugins->Control()->ReadController)
                {
                    g_Plugins->Control()->ReadController(Control, Command);
                }
                break;
            }
        }
        break;
    case 0x03: // Write controller pak
        if (Controllers[Control].Present != PRESENT_NONE)
        {
            switch (Controllers[Control].Plugin)
            {
            case PLUGIN_RAW:
                if (g_Plugins->Control()->ReadController)
                {
                    g_Plugins->Control()->ReadController(Control, Command);
                }
                break;
            }
        }
        break;
    }
}

void PifRamHandler::ProcessControllerCommand(int32_t Control, uint8_t * Command)
{
    CONTROL * Controllers = g_Plugins->Control()->PluginControllers();

    switch (Command[2])
    {
    case 0x00: // Check
    case 0xFF: // Reset and check?
        if ((Command[1] & 0x80) != 0)
        {
            break;
        }
        if (bShowPifRamErrors())
        {
            if (Command[0] != 1 || Command[1] != 3)
            {
                g_Notify->DisplayError("What am I meant to do with this controller command?");
            }
        }
        if (Controllers[Control].Present != PRESENT_NONE)
        {
            if (Controllers[Control].Present != PRESENT_MOUSE)
            {
                //N64 Controller
                Command[3] = 0x05;
                Command[4] = 0x00;
                switch (Controllers[Control].Plugin)
                {
                case PLUGIN_TRANSFER_PAK:
                case PLUGIN_RUMBLE_PAK:
                case PLUGIN_MEMPAK:
                case PLUGIN_RAW:
                    Command[5] = 1;
                    break;
                default: Command[5] = 0; break;
                }
            }
            else //if (Controllers[Control].Present == PRESENT_MOUSE)
            {
                //N64 Mouse
                Command[3] = 0x02;
                Command[4] = 0x00;
                Command[5] = 0x00;
            }
        }
        else
        {
            Command[1] |= 0x80;
        }
        break;
    case 0x01: // Read controller
        if (bShowPifRamErrors())
        {
            if (Command[0] != 1 || Command[1] != 4)
            {
                g_Notify->DisplayError("What am I meant to do with this controller command?");
            }
        }
        if (Controllers[Control].Present == PRESENT_NONE)
        {
            Command[1] |= 0x80;
        }
        break;
    case 0x02: // Read from controller pak
        if (LogControllerPak())
        {
            LogControllerPakData("Read: before getting results");
        }
        if (bShowPifRamErrors())
        {
            if (Command[0] != 3 || Command[1] != 33)
            {
                g_Notify->DisplayError("What am I meant to do with this controller command?");
            }
        }
        if (Controllers[Control].Present != PRESENT_NONE)
        {
            uint32_t address = (Command[3] << 8) | (Command[4] & 0xE0);
            uint8_t * data = &Command[5];

            switch (Controllers[Control].Plugin)
            {
            case PLUGIN_RUMBLE_PAK: Rumblepak::ReadFrom(address, data); break;
            case PLUGIN_MEMPAK: g_Mempak->ReadFrom(Control, address, data); break;
            case PLUGIN_TRANSFER_PAK: Transferpak::ReadFrom((uint16_t)address, data); break;
            case PLUGIN_RAW:
                if (g_Plugins->Control()->ControllerCommand)
                {
                    g_Plugins->Control()->ControllerCommand(Control, Command);
                }
                break;
            default:
                memset(&Command[5], 0, 0x20);
            }

            if (Controllers[Control].Plugin != PLUGIN_RAW)
            {
                Command[0x25] = CMempak::CalculateCrc(data);
            }
        }
        else
        {
            Command[1] |= 0x80;
        }
        if (LogControllerPak())
        {
            LogControllerPakData("Read: after getting results");
        }
        break;
    case 0x03: // Write controller pak
        if (LogControllerPak())
        {
            LogControllerPakData("Write: before processing");
        }
        if (bShowPifRamErrors())
        {
            if (Command[0] != 35 || Command[1] != 1)
            {
                g_Notify->DisplayError("What am I meant to do with this controller command?");
            }
        }
        if (Controllers[Control].Present != PRESENT_NONE)
        {
            uint32_t address = (Command[3] << 8) | (Command[4] & 0xE0);
            uint8_t * data = &Command[5];

            switch (Controllers[Control].Plugin)
            {
            case PLUGIN_MEMPAK: g_Mempak->WriteTo(Control, address, data); break;
            case PLUGIN_RUMBLE_PAK: Rumblepak::WriteTo(Control, address, data); break;
            case PLUGIN_TRANSFER_PAK: Transferpak::WriteTo((uint16_t)address, data); break;
            case PLUGIN_RAW:
                if (g_Plugins->Control()->ControllerCommand)
                {
                    g_Plugins->Control()->ControllerCommand(Control, Command);
                }
                break;
            }

            if (Controllers[Control].Plugin != PLUGIN_RAW)
            {
                Command[0x25] = CMempak::CalculateCrc(data);
            }
        }
        else
        {
            Command[1] |= 0x80;
        }
        if (LogControllerPak())
        {
            LogControllerPakData("Write: after processing");
        }
        break;
    default:
        if (bShowPifRamErrors())
        {
            g_Notify->DisplayError(stdstr_f("Unknown ControllerCommand %d", Command[2]).c_str());
        }
    }
}

void PifRamHandler::SystemReset(void)
{
    memset(m_PifRam, 0, sizeof(m_PifRam));
    memset(m_PifRom, 0, sizeof(m_PifRom));
}

uint32_t PifRamHandler::swap32by8(uint32_t word)
{
    const uint32_t swapped =
#if defined(_MSC_VER)
        _byteswap_ulong(word)
#elif defined(__GNUC__)
        __builtin_bswap32(word)
#else
        (word & 0x000000FFul) << 24 | (word & 0x0000FF00ul) << 8 | (word & 0x00FF0000ul) >> 8 | (word & 0xFF000000ul) >> 24
#endif
        ;
    return (swapped & 0xFFFFFFFFul);
}