path: root/src/core/hw/gpu.cpp

// Copyright 2014 Citra Emulator Project
// Licensed under GPLv2 or any later version
// Refer to the license.txt file included.

#include "common/common_types.h"

#include "core/arm/arm_interface.h"

#include "core/settings.h"
#include "core/core.h"
#include "core/mem_map.h"

#include "core/hle/hle.h"
#include "core/hle/service/gsp_gpu.h"
#include "core/hle/service/dsp_dsp.h"

#include "core/hw/gpu.h"

#include "video_core/command_processor.h"
#include "video_core/video_core.h"
#include <video_core/color.h>


namespace GPU {

Regs g_regs;

bool g_skip_frame = false;              ///< True if the current frame was skipped

static u64 frame_ticks      = 0;        ///< 268MHz / gpu_refresh_rate frames per second
static u64 line_ticks       = 0;        ///< Number of ticks for a screen line
static u32 cur_line         = 0;        ///< Current screen line
static u64 last_update_tick = 0;        ///< CPU ticl count from last GPU update
static u64 frame_count      = 0;        ///< Number of frames drawn
static bool last_skip_frame = false;    ///< True if the last frame was skipped

template <typename T>
inline void Read(T &var, const u32 raw_addr) {
    u32 addr = raw_addr - 0x1EF00000;
    u32 index = addr / 4;

    // Reads other than u32 are untested, so I'd rather have them abort than silently fail
    if (index >= Regs::NumIds() || !std::is_same<T, u32>::value) {
        LOG_ERROR(HW_GPU, "unknown Read%lu @ 0x%08X", sizeof(var) * 8, addr);
        return;
    }

    var = g_regs[addr / 4];
}

template <typename T>
inline void Write(u32 addr, const T data) {
    addr -= 0x1EF00000;
    u32 index = addr / 4;

    // Writes other than u32 are untested, so I'd rather have them abort than silently fail
    if (index >= Regs::NumIds() || !std::is_same<T, u32>::value) {
        LOG_ERROR(HW_GPU, "unknown Write%lu 0x%08X @ 0x%08X", sizeof(data) * 8, (u32)data, addr);
        return;
    }

    g_regs[index] = static_cast<u32>(data);

    switch (index) {

    // Memory fills are triggered once the fill value is written.
    // NOTE: This is not verified.
    case GPU_REG_INDEX_WORKAROUND(memory_fill_config[0].value, 0x00004 + 0x3):
    case GPU_REG_INDEX_WORKAROUND(memory_fill_config[1].value, 0x00008 + 0x3):
    {
        const bool is_second_filler = (index != GPU_REG_INDEX(memory_fill_config[0].value));
        const auto& config = g_regs.memory_fill_config[is_second_filler];

        // TODO: Not sure if this check should be done at GSP level instead
        if (config.address_start) {
            // TODO: Not sure if this algorithm is correct, particularly because it doesn't use the size member at all
            u32* start = (u32*)Memory::GetPointer(Memory::PhysicalToVirtualAddress(config.GetStartAddress()));
            u32* end = (u32*)Memory::GetPointer(Memory::PhysicalToVirtualAddress(config.GetEndAddress()));
            for (u32* ptr = start; ptr < end; ++ptr)
                *ptr = bswap32(config.value); // TODO: This is just a workaround to missing framebuffer format emulation

            LOG_TRACE(HW_GPU, "MemoryFill from 0x%08x to 0x%08x", config.GetStartAddress(), config.GetEndAddress());
        }
        break;
    }

    case GPU_REG_INDEX(display_transfer_config.trigger):
    {
        const auto& config = g_regs.display_transfer_config;
        if (config.trigger & 1) {
            u8* source_pointer = Memory::GetPointer(Memory::PhysicalToVirtualAddress(config.GetPhysicalInputAddress()));
            u8* dest_pointer = Memory::GetPointer(Memory::PhysicalToVirtualAddress(config.GetPhysicalOutputAddress()));

            for (u32 y = 0; y < config.output_height; ++y) {
                // TODO: Why does the register seem to hold twice the framebuffer width?
                for (u32 x = 0; x < config.output_width; ++x) {
                    struct {
                        int r, g, b, a;
                    } source_color = { 0, 0, 0, 0 };

                    // Cheap emulation of horizontal scaling: Just skip each second pixel of the
                    // input framebuffer. We keep track of this in the pixel_skip variable.
                    unsigned pixel_skip = (config.scale_horizontally != 0) ? 2 : 1;

                    switch (config.input_format) {
                    case Regs::PixelFormat::RGBA8:
                    {
                        // TODO: Most likely got the component order messed up.
                        u8* srcptr = source_pointer + x * 4 * pixel_skip + y * config.input_width * 4 * pixel_skip;
                        source_color.r = srcptr[0]; // blue
                        source_color.g = srcptr[1]; // green
                        source_color.b = srcptr[2]; // red
                        source_color.a = srcptr[3]; // alpha
                        break;
                    }

                    case Regs::PixelFormat::RGB5A1:
                    {
                        u16 srcval = *(u16*)(source_pointer + x * 4 * pixel_skip + y * config.input_width * 4 * pixel_skip);
                        source_color.r = Color::Convert5To8((srcval >> 11) & 0x1F); // red
                        source_color.g = Color::Convert5To8((srcval >>  6) & 0x1F); // green
                        source_color.b = Color::Convert5To8((srcval >>  1) & 0x1F); // blue
                        source_color.a = Color::Convert1To8(srcval & 0x1);          // alpha
                        break;
                    }

                    case Regs::PixelFormat::RGBA4:
                    {
                        u16 srcval = *(u16*)(source_pointer + x * 4 * pixel_skip + y * config.input_width * 4 * pixel_skip);
                        source_color.r = Color::Convert4To8((srcval >> 12) & 0xF); // red
                        source_color.g = Color::Convert4To8((srcval >>  8) & 0xF); // green
                        source_color.b = Color::Convert4To8((srcval >>  4) & 0xF); // blue
                        source_color.a = Color::Convert4To8( srcval        & 0xF); // alpha
                        break;
                    }

                    default:
                        LOG_ERROR(HW_GPU, "Unknown source framebuffer format %x", config.input_format.Value());
                        break;
                    }

                    switch (config.output_format) {
                    /*case Regs::PixelFormat::RGBA8:
                    {
                        // TODO: Untested
                        u8* dstptr = (u32*)(dest_pointer + x * 4 + y * config.output_width * 4);
                        dstptr[0] = source_color.r;
                        dstptr[1] = source_color.g;
                        dstptr[2] = source_color.b;
                        dstptr[3] = source_color.a;
                        break;
                    }*/

                    case Regs::PixelFormat::RGB8:
                    {
                        // TODO: Most likely got the component order messed up.
                        u8* dstptr = dest_pointer + x * 3 + y * config.output_width * 3;
                        dstptr[0] = source_color.r; // blue
                        dstptr[1] = source_color.g; // green
                        dstptr[2] = source_color.b; // red
                        break;
                    }

                    case Regs::PixelFormat::RGB5A1:
                    {
                        u16* dstptr = (u16*)(dest_pointer + x * 2 + y * config.output_width * 2);
                        *dstptr = ((source_color.r >> 3) << 11) | ((source_color.g >> 3) << 6)
                                | ((source_color.b >> 3) <<  1) | ( source_color.a >> 7);
                        break;
                    }

                    case Regs::PixelFormat::RGBA4:
                    {
                        u16* dstptr = (u16*)(dest_pointer + x * 2 + y * config.output_width * 2);
                        *dstptr = ((source_color.r >> 4) << 12) | ((source_color.g >> 4) << 8)
                                | ((source_color.b >> 4) <<  4) | ( source_color.a >> 4);
                        break;
                    }

                    default:
                        LOG_ERROR(HW_GPU, "Unknown destination framebuffer format %x", config.output_format.Value());
                        break;
                    }
                }
            }

            LOG_TRACE(HW_GPU, "DisplayTriggerTransfer: 0x%08x bytes from 0x%08x(%ux%u)-> 0x%08x(%ux%u), dst format %x",
                      config.output_height * config.output_width * 4,
                      config.GetPhysicalInputAddress(), (u32)config.input_width, (u32)config.input_height,
                      config.GetPhysicalOutputAddress(), (u32)config.output_width, (u32)config.output_height,
                      config.output_format.Value());
        }
        break;
    }

    // Seems like writing to this register triggers processing
    case GPU_REG_INDEX(command_processor_config.trigger):
    {
        const auto& config = g_regs.command_processor_config;
        if (config.trigger & 1)
        {
            u32* buffer = (u32*)Memory::GetPointer(Memory::PhysicalToVirtualAddress(config.GetPhysicalAddress()));
            Pica::CommandProcessor::ProcessCommandList(buffer, config.size);
        }
        break;
    }

    default:
        break;
    }
}

// Explicitly instantiate template functions because we aren't defining this in the header:

template void Read<u64>(u64 &var, const u32 addr);
template void Read<u32>(u32 &var, const u32 addr);
template void Read<u16>(u16 &var, const u32 addr);
template void Read<u8>(u8 &var, const u32 addr);

template void Write<u64>(u32 addr, const u64 data);
template void Write<u32>(u32 addr, const u32 data);
template void Write<u16>(u32 addr, const u16 data);
template void Write<u8>(u32 addr, const u8 data);

/// Update hardware
void Update() {
    auto& framebuffer_top = g_regs.framebuffer_config[0];

    // Synchronize GPU on a thread reschedule: Because we cannot accurately predict a vertical
    // blank, we need to simulate it. Based on testing, it seems that retail applications work more
    // accurately when this is signalled between thread switches.

    if (HLE::g_reschedule) {
        u64 current_ticks = Core::g_app_core->GetTicks();
        u32 num_lines = static_cast<u32>((current_ticks - last_update_tick) / line_ticks);

        // Synchronize line...
        if (num_lines > 0) {
            GSP_GPU::SignalInterrupt(GSP_GPU::InterruptId::PDC0);
            cur_line += num_lines;
            last_update_tick += (num_lines * line_ticks);
        }

        // Synchronize frame...
        if (cur_line >= framebuffer_top.height) {
            cur_line = 0;
            frame_count++;
            last_skip_frame = g_skip_frame;
            g_skip_frame = (frame_count & Settings::values.frame_skip) != 0;

            // Swap buffers based on the frameskip mode, which is a little bit tricky. When
            // a frame is being skipped, nothing is being rendered to the internal framebuffer(s).
            // So, we should only swap frames if the last frame was rendered. The rules are:
            //  - If frameskip == 0 (disabled), always swap buffers
            //  - If frameskip == 1, swap buffers every other frame (starting from the first frame)
            //  - If frameskip > 1, swap buffers every frameskip^n frames (starting from the second frame)
            if ((((Settings::values.frame_skip != 1) ^ last_skip_frame) && last_skip_frame != g_skip_frame) || 
                   Settings::values.frame_skip == 0) {
                VideoCore::g_renderer->SwapBuffers();
            }

            // Signal to GSP that GPU interrupt has occurred
            GSP_GPU::SignalInterrupt(GSP_GPU::InterruptId::PDC1);

            // TODO(bunnei): Fake a DSP interrupt on each frame. This does not belong here, but
            // until we can emulate DSP interrupts, this is probably the only reasonable place to do
            // this. Certain games expect this to be periodically signaled.
            DSP_DSP::SignalInterrupt();
        }
    }
}

/// Initialize hardware
void Init() {
    auto& framebuffer_top = g_regs.framebuffer_config[0];
    auto& framebuffer_sub = g_regs.framebuffer_config[1];

    // Setup default framebuffer addresses (located in VRAM)
    // .. or at least these are the ones used by system applets.
    // There's probably a smarter way to come up with addresses
    // like this which does not require hardcoding.
    framebuffer_top.address_left1  = 0x181E6000;
    framebuffer_top.address_left2  = 0x1822C800;
    framebuffer_top.address_right1 = 0x18273000;
    framebuffer_top.address_right2 = 0x182B9800;
    framebuffer_sub.address_left1  = 0x1848F000;
    //framebuffer_sub.address_left2  = unknown;
    framebuffer_sub.address_right1 = 0x184C7800;
    //framebuffer_sub.address_right2 = unknown;

    framebuffer_top.width = 240;
    framebuffer_top.height = 400;
    framebuffer_top.stride = 3 * 240;
    framebuffer_top.color_format = Regs::PixelFormat::RGB8;
    framebuffer_top.active_fb = 0;

    framebuffer_sub.width = 240;
    framebuffer_sub.height = 320;
    framebuffer_sub.stride = 3 * 240;
    framebuffer_sub.color_format = Regs::PixelFormat::RGB8;
    framebuffer_sub.active_fb = 0;

    frame_ticks = 268123480 / Settings::values.gpu_refresh_rate;
    line_ticks = (GPU::frame_ticks / framebuffer_top.height);
    cur_line = 0;
    last_update_tick = Core::g_app_core->GetTicks();
    last_skip_frame = false;
    g_skip_frame = false;

    LOG_DEBUG(HW_GPU, "initialized OK");
}

/// Shutdown hardware
void Shutdown() {
    LOG_DEBUG(HW_GPU, "shutdown OK");
}

} // namespace