FinalIII.h

// -----------------------------------------------------------------------------
// This file is part of VirtualC64
//
// Copyright (C) Dirk W. Hoffmann. www.dirkwhoffmann.de
// This FILE is dual-licensed. You are free to choose between:
//
//     - The GNU General Public License v3 (or any later version)
//     - The Mozilla Public License v2
//
// SPDX-License-Identifier: GPL-3.0-or-later OR MPL-2.0
// -----------------------------------------------------------------------------
 
#pragma once
 
#include "Cartridge.h"
 
namespace vc64 {
 
class FinalIII final : public Cartridge {
 
    CartridgeTraits traits = {
 
        .type       = CRT_FINAL_III,
        .title      = "Final Cartridge III",
 
        .buttons    = 2,
        .button1    = "Freeze",
        .button2    = "Reset"
    };
 
    virtual const CartridgeTraits &getCartridgeTraits() const override { return traits; }
 
    // Indicates whether the freeze button is pressed
    bool freeezeButtonIsPressed = false;
 
    /* The QD pin of the Final Cartridge III's 4-bit counter. The counter's
     * purpose is to delay the grounding the Game line when the freeze button
     * is pressed. Doing so lets the CPU read the NMI vector with the old
     * Game/Exrom combination.
     */
    bool qD = true;
 
 
    //
    // Initializing
    //
 
public:
 
    using Cartridge::Cartridge;
    void resetCartConfig() override;
 
 
    //
    // Methods from CoreObject
    //
 
private:
 
    void _dump(Category category, std::ostream& os) const override;
 
 
    //
    // Methods from CoreComponent
    //
 
public:
 
    FinalIII& operator= (const FinalIII& other) {
 
        Cartridge::operator=(other);
 
        CLONE(qD)
        CLONE(freeezeButtonIsPressed)
 
        return *this;
    }
    virtual void clone(const Cartridge &other) override { *this = (const FinalIII &)other; }
 
    template <class T>
    void serialize(T& worker)
    {
        worker
 
        << qD;
 
        if (isResetter(worker)) return;
 
        worker
 
        << freeezeButtonIsPressed;
 
    } CARTRIDGE_SERIALIZERS(serialize);
 
    void _reset(bool hard) override;
 
 
    //
    // Accessing cartridge memory
    //
 
public:
 
    u8 peekIO1(u16 addr) override;
    u8 spypeekIO1(u16 addr) const override;
    u8 peekIO2(u16 addr) override;
    u8 spypeekIO2(u16 addr) const override;
    void pokeIO2(u16 addr, u8 value) override;
    void nmiDidTrigger() override;
 
 
    //
    // Accessing the control register
    //
 
private:
 
    void setControlReg(u8 value);
    bool hidden() const { return (control & 0x80) != 0; }
    bool nmi() const { return (control & 0x40) != 0; }
    bool game() const { return (control & 0x20) != 0; }
    bool exrom() const { return (control & 0x10) != 0; }
    u8 bank() const { return (control & 0x03); }
 
    /* Indicates if the control register is write enabled. Final Cartridge III
     * enables and disables the control register by masking the clock signal.
     */
    bool writeEnabled() const;
 
    /* Updates the NMI line. The NMI line is driven by the control register and
     * the current position of the freeze button.
     */
    void updateNMI();
 
    /* Updates the Game line. The game line is driven by the control register
     * and counter output qD.
     */
    void updateGame();
 
 
    //
    // Operating buttons
    //
 
    isize numButtons() const override { return 2; }
    const char *getButtonTitle(isize nr) const override;
    void pressButton(isize nr) override;
    void releaseButton(isize nr) override;
};
 
}