Carnivore2.hh

Go to the documentation of this file.

#ifndef CARNIVORE2_HH
#define CARNIVORE2_HH
 
#include "MSXDevice.hh"
#include "MSXMapperIO.hh"
#include "MSXCPUInterface.hh"
#include "AmdFlash.hh"
#include "EEPROM_93C46.hh"
#include "Math.hh"
#include "Ram.hh"
#include "SCC.hh"
#include "AY8910.hh"
#include "YM2413.hh"
#include "serialize_meta.hh"
#include <array>
#include <utility>
 
namespace openmsx {
 
class IDEDevice;
 
class Carnivore2 final
        : public MSXDevice
        , public MSXMapperIOClient
        , public GlobalReadClient<Carnivore2, CT_Interval<0x0000>, CT_Interval<0x4000, 0x4010>>
{
public:
        explicit Carnivore2(const DeviceConfig& config);
        ~Carnivore2() override;
 
        void powerUp(EmuTime::param time) override;
        void reset(EmuTime::param time) override;
 
        [[nodiscard]] byte readMem(word address, EmuTime::param time) override;
        [[nodiscard]] byte peekMem(word address, EmuTime::param time) const override;
        void writeMem(word address, byte value, EmuTime::param time) override;
        void globalRead(word address, EmuTime::param time) override;
 
        [[nodiscard]] byte readIO(word port, EmuTime::param time) override;
        [[nodiscard]] byte peekIO(word port, EmuTime::param time) const override;
        void writeIO(word port, byte value, EmuTime::param time) override;
        [[nodiscard]] byte getSelectedSegment(byte page) const override;
 
        template<typename Archive>
        void serialize(Archive& ar, unsigned version);
 
private:
        // config regs
        [[nodiscard]] unsigned getDirectFlashAddr() const;
        [[nodiscard]] byte peekConfigRegister(word address, EmuTime::param time) const;
        [[nodiscard]] byte readConfigRegister(word address, EmuTime::param time) const;
        void writeSndLVL(byte value, EmuTime::param time);
        void writeCfgEEPR(byte value, EmuTime::param time);
        void writePSGCtrl(byte value, EmuTime::param time);
        void writePSGAlt(byte value);
        void writePFXN(byte value);
        void writeConfigRegister(word address, byte value, EmuTime::param time);
 
        [[nodiscard]] bool sccEnabled()        const { return configRegs[0x00] & 0x10; }
        [[nodiscard]] bool delayedConfig()     const { return configRegs[0x00] & 0x08; }
        [[nodiscard]] bool delayedConfig4000() const { return configRegs[0x00] & 0x04; }
        [[nodiscard]] bool readBIOSfromRAM()   const { return configRegs[0x00] & 0x02; }
 
        [[nodiscard]] bool slotExpanded() const { return configRegs[0x1e] & 0x80; }
        [[nodiscard]] bool memMapReadEnabled() const {
                return (configRegs[0x1e] & 0x40) && !(port3C & 0x20);
        }
        [[nodiscard]] bool fmPacPortEnabled2() const { return configRegs[0x1e] & 0x20; }
        [[nodiscard]] bool subSlotEnabled(unsigned slot) const {
                assert(slot < 4);
                return configRegs[0x1e] & (1 << slot);
        }
        [[nodiscard]] bool writePort3cEnabled() const {
                return (configRegs[0x1e] & 0x10) && !(port3C & 0x20);
        }
 
        enum class SubDevice { MultiMapper, IDE, MemoryMapper, FmPac, Nothing };
 
        [[nodiscard]] SubDevice getSubDevice(word address) const;
 
        // multi-mapper
        [[nodiscard]] bool isConfigReg(word address) const;
        [[nodiscard]] std::pair<unsigned, byte> decodeMultiMapper(word address) const;
        [[nodiscard]] bool sccAccess(word address) const;
        [[nodiscard]] byte readMultiMapperSlot(word address, EmuTime::param time);
        [[nodiscard]] byte peekMultiMapperSlot(word address, EmuTime::param time) const;
        void writeMultiMapperSlot(word address, byte value, EmuTime::param time);
 
        // IDE
        [[nodiscard]] byte readIDESlot(word address, EmuTime::param time);
        [[nodiscard]] byte peekIDESlot(word address, EmuTime::param time) const;
        void writeIDESlot(word address, byte value, EmuTime::param time);
        [[nodiscard]] word ideReadData(EmuTime::param time);
        void ideWriteData(word value, EmuTime::param time);
        [[nodiscard]] byte ideReadReg(byte reg, EmuTime::param time);
        void ideWriteReg(byte reg, byte value, EmuTime::param time);
        [[nodiscard]] bool ideRegsEnabled() const { return ideControlReg & 0x01; }
        [[nodiscard]] byte ideBank() const { return Math::reverseByte(ideControlReg & 0xe0); }
 
        // memory mapper
        [[nodiscard]] bool isMemMapControl(word address) const;
        [[nodiscard]] unsigned getMemoryMapperAddress(word address) const;
        [[nodiscard]] bool isMemoryMapperWriteProtected(word address) const;
        [[nodiscard]] byte peekMemoryMapperSlot(word address) const;
        [[nodiscard]] byte readMemoryMapperSlot(word address) const;
        void writeMemoryMapperSlot(word address, byte value);
 
        // fm-pac
        [[nodiscard]] byte readFmPacSlot(word address);
        [[nodiscard]] byte peekFmPacSlot(word address) const;
        void writeFmPacSlot(word address, byte value, EmuTime::param time);
        [[nodiscard]] bool fmPacPortEnabled1() const { return fmPacEnable & 0x01; }
        [[nodiscard]] bool fmPacSramEnabled() const {
                return (fmPac5ffe == 0x4d) && (fmPac5fff == 0x69);
        }
        // User-defined ID and control port I/O
        [[nodiscard]] byte idControlPort() const { return configRegs[0x35]; }
 
private:
        AmdFlash flash; // 8MB
        Ram ram; // 2MB
        EEPROM_93C46 eeprom;
        std::array<byte, 64> configRegs; // in reality there are less than 64
        std::array<byte, 64> shadowConfigRegs; // only regs[0x05..0x1e] have a shadow counterpart
        byte subSlotReg;
        byte port3C;
 
        // multi-mapper
        SCC scc;
        byte sccMode;
        std::array<byte, 4> sccBank; // mostly write-only, except to test for scc-bank
 
        // PSG
        AY8910 psg;
        byte psgLatch;
 
        // ide
        std::array<std::unique_ptr<IDEDevice>, 2> ideDevices;
        byte ideSoftReset;
        byte ideSelectedDevice;
        byte ideControlReg;
        byte ideRead;
        byte ideWrite;
 
        // memory-mapper
        std::array<byte, 4> memMapRegs; // only stores 6 lower bits
 
        // fm-pac
        YM2413 ym2413;
        byte fmPacEnable; // enable
        byte fmPacBank; // bank
        byte fmPac5ffe;
        byte fmPac5fff;
 
        // User-defined ID and control port I/O
        byte PF0_RV;
};
SERIALIZE_CLASS_VERSION(Carnivore2, 3);
 
} // namespace openmsx
 
#endif