kernel.hh

Go to the documentation of this file.

/*
 
MIT License
 
Copyright (c) 2022 PCSX-Redux authors
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 
*/
 
#pragma once
 
#include <EASTL/functional.h>
#include <stdint.h>
 
#include <source_location>
 
namespace psyqo {
 
namespace DMA {
 
enum DmaCallback {
    FROM_ISR,
    FROM_MAIN_LOOP,
};
 
}
 
class Application;
 
namespace Kernel {
 
#ifdef PSYQO_RELEASE
static constexpr bool debugMode = false;
#else
static constexpr bool debugMode = true;
#endif
 
namespace Internal {
static inline uint32_t getCop0Status() {
#ifndef PS1_PC_PORT
    uint32_t r;
    asm volatile("mfc0 %0, $12 ; nop" : "=r"(r));
    return r;
#else
    return 0;
#endif
}
 
static inline void setCop0Status(uint32_t r) {
#ifndef PS1_PC_PORT
    asm("mtc0 %0, $12 ; nop" : : "r"(r));
#endif
}
 
[[noreturn]] void abort(const char* msg, std::source_location location = std::source_location::current());
[[noreturn]] void abort();
 
}  // namespace Internal
 
static inline void fastEnterCriticalSection() {
#ifndef PS1_PC_PORT
    asm volatile("mtc0 %0, $12 ; nop ; nop" : : "r"(0x40000000));
#endif
}
 
static inline void fastLeaveCriticalSection() {
#ifndef PS1_PC_PORT
    asm volatile("mtc0 %0, $12" : : "r"(0x40000401));
#endif
}
 
// Compiler barrier: memory accesses above it stay ahead of the CHCR store that starts a DMA.
static inline void dmaReleaseBarrier() { __asm__ volatile("" ::: "memory"); }
 
// Compiler barrier: memory accesses below it stay after the point a DMA was seen complete.
static inline void dmaAcquireBarrier() { __asm__ volatile("" ::: "memory"); }
 
template <typename T>
static void waitForStatus(T mask, T expected, const volatile T* value) {
    while ((*value & mask) != expected);
    dmaAcquireBarrier();
}
 
enum class DMA : unsigned {
    MDECin,
    MDECout,
    GPU,
    CDRom,
    SPU,
    EXP1,
    OTC,
    Max,
};
 
enum class IRQ : unsigned {
    VBlank,
    GPU,
    CDRom,
    DMA,
    Timer0,
    Timer1,
    Timer2,
    Controller,
    SIO,
    SPU,
    PIO,
    Max,
};
 
[[noreturn]] static inline void abort(const char* msg,
                                      std::source_location location = std::source_location::current()) {
    if constexpr (debugMode) {
        Internal::abort(msg, location);
    } else if constexpr (!debugMode) {
        (void)msg;
        (void)location;
        Internal::abort();
    }
}
 
void takeOverKernel();
 
bool isKernelTakenOver();
 
void installCrashHandler();
 
void queueIRQHandler(IRQ irq, eastl::function<void()>&& lambda);
 
uint32_t openEvent(uint32_t classId, uint32_t spec, uint32_t mode, eastl::function<void()>&& lambda);
 
unsigned registerDmaEvent(DMA channel, eastl::function<void()>&& lambda);
 
void flushCache();
 
void enableDma(DMA channel, unsigned priority = 7);
 
void disableDma(DMA channel);
 
void unregisterDmaEvent(unsigned slot);
 
void queueCallback(eastl::function<void()>&& lambda);
 
void queueCallbackFromISR(eastl::function<void()>&& lambda);
 
void setBreakHandler(unsigned category, eastl::function<bool(uint32_t)>&& handler);
 
void queuePsyqoBreakHandler(eastl::function<bool(uint32_t)>&& handler);
 
namespace Internal {
void pumpCallbacks();
void prepare(Application&);
void addInitializer(eastl::function<void(Application&)>&& lambda);
void addOnFrame(eastl::function<void()>&& lambda);
void beginFrame();
[[noreturn]] void crashHandler(uint32_t exceptionCode, uint32_t* kernelRegisters);
}  // namespace Internal
 
inline void assert(bool condition, const char* message,
                   std::source_location location = std::source_location::current()) {
    if constexpr (debugMode) {
        if (!condition) {
            Internal::abort(message, location);
            __builtin_unreachable();
        }
    } else if constexpr (!debugMode) {
        (void)message;
        (void)location;
        if (!condition) {
            Internal::abort();
            __builtin_unreachable();
        }
    }
}
 
}  // namespace Kernel
 
}  // namespace psyqo