Cartridge.hpp

Go to the documentation of this file.

//
// Created by anonymus-raccoon on 1/27/20.
//
 
#pragma once
 
#include "InterruptVectors.hpp"
#include "Memory/AMemory.hpp"
#include "Memory/ARectangleMemory.hpp"
#include "Models/Ints.hpp"
#include "Ram/Ram.hpp"
#include <filesystem>
#include <string>
 
namespace ComSquare::Cartridge
{
    enum CartridgeType
    {
        Game,
        Audio
    };
 
    enum MappingMode
    {
        LoRom = 1u << 0u,
        HiRom = 1u << 1u,
        SlowRom = 1u << 2u,
        FastRom = 1u << 3u,
        ExRom = 1u << 4u
    };
    MappingMode operator|(const MappingMode &self, const MappingMode &other);
    MappingMode &operator|=(MappingMode &self, const MappingMode &other);
 
    struct Header
    {
        std::string gameName;
        MappingMode mappingMode {};
        uint8_t romType = 0;
        unsigned romSize = 0;
        unsigned sramSize = 0;
        union
        {
            uint8_t creatorIDs[2];
            uint16_t creatorID = 0;
        };
        uint8_t version = 0;
        union
        {
            uint8_t checksumComplements[2];
            uint16_t checksumComplement = 0;
        };
        union
        {
            uint8_t checksums[2];
            uint16_t checksum = 0;
        };
        InterruptVectors nativeInterrupts {};
        InterruptVectors emulationInterrupts {};
 
        Header() = default;
        Header(const Header &) = default;
        Header &operator=(const Header &) = default;
        ~Header() = default;
    };
 
    class Cartridge : public Ram::Ram
    {
    private:
        std::string _romPath;
        uint16_t _romStart = 0;
 
        static size_t getRomSize(const std::string &romPath);
        bool _loadHeader();
        bool _isSPCFile();
        uint32_t _getHeaderAddress();
        Header _mapHeader(uint32_t headerAddress);
        CartridgeType _type = Game;
        static constexpr std::string_view _magicSPC = "SNES-SPC700 Sound File Data v0.30";
 
    public:
        Cartridge();
        explicit Cartridge(const std::string &romPath);
        Cartridge(const Cartridge &) = delete;
        Cartridge &operator=(const Cartridge &) = delete;
        ~Cartridge() override = default;
 
        Header header;
 
        CartridgeType getType();
 
        uint8_t read(uint24_t addr) override;
 
        void write(uint24_t addr, uint8_t data) override;
 
        [[nodiscard]] std::filesystem::path getRomPath() const;
 
        uint24_t getSize() const override;
 
        void loadRom(const std::string& path);
    };
}// namespace ComSquare::Cartridge