dolphin/Source/Core/Core/HW/GPFifo.cpp

// Copyright 2008 Dolphin Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later

#include "Core/HW/GPFifo.h"

#include <cstddef>
#include <cstring>

#include "Common/ChunkFile.h"
#include "Common/CommonTypes.h"
#include "Common/Swap.h"
#include "Core/HW/Memmap.h"
#include "Core/HW/ProcessorInterface.h"
#include "Core/PowerPC/JitInterface.h"
#include "Core/PowerPC/PowerPC.h"
#include "Core/System.h"
#include "VideoCommon/CommandProcessor.h"

namespace GPFifo
{
GPFifoManager::GPFifoManager(Core::System& system) : m_system(system)
{
}

// 32 Byte gather pipe with extra space
// Overfilling is no problem (up to the real limit), CheckGatherPipe will blast the
// contents in nicely sized chunks
//
// Other optimizations to think about:
// - If the GP is NOT linked to the FIFO, just blast to memory byte by word
// - If the GP IS linked to the FIFO, use a fast wrapping buffer and skip writing to memory
//
// Both of these should actually work! Only problem is that we have to decide at run time,
// the same function could use both methods. Compile 2 different versions of each such block?

size_t GPFifoManager::GetGatherPipeCount()
{
  return m_system.GetPPCState().gather_pipe_ptr - m_gather_pipe;
}

void GPFifoManager::SetGatherPipeCount(size_t size)
{
  m_system.GetPPCState().gather_pipe_ptr = m_gather_pipe + size;
}

void GPFifoManager::DoState(PointerWrap& p)
{
  p.Do(m_gather_pipe);
  u32 pipe_count = static_cast<u32>(GetGatherPipeCount());
  p.Do(pipe_count);
  SetGatherPipeCount(pipe_count);
}

void GPFifoManager::Init()
{
  ResetGatherPipe();
  m_system.GetPPCState().gather_pipe_base_ptr = m_gather_pipe;
  memset(m_gather_pipe, 0, sizeof(m_gather_pipe));
}

bool GPFifoManager::IsBNE() const
{
  // TODO: It's not clear exactly when the BNE (buffer not empty) bit is set.
  // The PPC 750cl manual says in section 2.1.2.12 "Write Pipe Address Register (WPAR)" (page 78):
  // "A mfspr WPAR is used to read the BNE bit to check for any outstanding data transfers."
  // In section 9.4.2 "Write Gather Pipe Operation" (page 327) it says:
  // "Software can check WPAR[BNE] to determine if the buffer is empty or not."
  // On page 327, it also says "The only way for software to flush out a partially full 32 byte
  // block is to fill up the block with dummy data,."
  // On page 328, it says: "Before disabling the write gather pipe, the WPAR[BNE] bit should be
  // tested to insure that all outstanding transfers from the buffer to the bus have completed."
  //
  // GXRedirectWriteGatherPipe and GXRestoreWriteGatherPipe (used for display lists) wait for
  // the bit to be 0 before continuing, so it can't be a case of any data existing in the FIFO;
  // it might be a case of over 32 bytes being stored pending transfer to memory? For now, always
  // return false since that prevents hangs in games that use display lists.
  return false;
}

void GPFifoManager::ResetGatherPipe()
{
  SetGatherPipeCount(0);
}

void GPFifoManager::UpdateGatherPipe()
{
  auto& system = m_system;
  auto& memory = system.GetMemory();
  auto& processor_interface = system.GetProcessorInterface();

  size_t pipe_count = GetGatherPipeCount();
  size_t processed;
  u8* cur_mem = memory.GetPointer(processor_interface.m_fifo_cpu_write_pointer);
  for (processed = 0; pipe_count >= GATHER_PIPE_SIZE; processed += GATHER_PIPE_SIZE)
  {
    // copy the GatherPipe
    memcpy(cur_mem, m_gather_pipe + processed, GATHER_PIPE_SIZE);
    pipe_count -= GATHER_PIPE_SIZE;

    // increase the CPUWritePointer
    if (processor_interface.m_fifo_cpu_write_pointer == processor_interface.m_fifo_cpu_end)
    {
      processor_interface.m_fifo_cpu_write_pointer = processor_interface.m_fifo_cpu_base;
      cur_mem = memory.GetPointer(processor_interface.m_fifo_cpu_write_pointer);
    }
    else
    {
      cur_mem += GATHER_PIPE_SIZE;
      processor_interface.m_fifo_cpu_write_pointer += GATHER_PIPE_SIZE;
    }

    system.GetCommandProcessor().GatherPipeBursted(system);
  }

  // move back the spill bytes
  memmove(m_gather_pipe, m_gather_pipe + processed, pipe_count);
  SetGatherPipeCount(pipe_count);
}

void GPFifoManager::FastCheckGatherPipe()
{
  if (GetGatherPipeCount() >= GATHER_PIPE_SIZE)
  {
    UpdateGatherPipe();
  }
}

void GPFifoManager::CheckGatherPipe()
{
  if (GetGatherPipeCount() >= GATHER_PIPE_SIZE)
  {
    UpdateGatherPipe();

    // Profile where slow FIFO writes are occurring.
    JitInterface::CompileExceptionCheck(JitInterface::ExceptionType::FIFOWrite);
  }
}

void GPFifoManager::Write8(const u8 value)
{
  FastWrite8(value);
  CheckGatherPipe();
}

void GPFifoManager::Write16(const u16 value)
{
  FastWrite16(value);
  CheckGatherPipe();
}

void GPFifoManager::Write32(const u32 value)
{
  FastWrite32(value);
  CheckGatherPipe();
}

void GPFifoManager::Write64(const u64 value)
{
  FastWrite64(value);
  CheckGatherPipe();
}

void GPFifoManager::FastWrite8(const u8 value)
{
  auto& ppc_state = m_system.GetPPCState();
  *ppc_state.gather_pipe_ptr = value;
  ppc_state.gather_pipe_ptr += sizeof(u8);
}

void GPFifoManager::FastWrite16(u16 value)
{
  value = Common::swap16(value);
  auto& ppc_state = m_system.GetPPCState();
  std::memcpy(ppc_state.gather_pipe_ptr, &value, sizeof(u16));
  ppc_state.gather_pipe_ptr += sizeof(u16);
}

void GPFifoManager::FastWrite32(u32 value)
{
  value = Common::swap32(value);
  auto& ppc_state = m_system.GetPPCState();
  std::memcpy(ppc_state.gather_pipe_ptr, &value, sizeof(u32));
  ppc_state.gather_pipe_ptr += sizeof(u32);
}

void GPFifoManager::FastWrite64(u64 value)
{
  value = Common::swap64(value);
  auto& ppc_state = m_system.GetPPCState();
  std::memcpy(ppc_state.gather_pipe_ptr, &value, sizeof(u64));
  ppc_state.gather_pipe_ptr += sizeof(u64);
}

void UpdateGatherPipe(GPFifoManager& gpfifo)
{
  gpfifo.UpdateGatherPipe();
}

void FastCheckGatherPipe(GPFifoManager& gpfifo)
{
  gpfifo.FastCheckGatherPipe();
}
}  // namespace GPFifo