IDECDROM.hh

Go to the documentation of this file.

#ifndef IDECDROM_HH
#define IDECDROM_HH
 
#include "AbstractIDEDevice.hh"
#include "MSXMotherBoard.hh"
#include "File.hh"
#include "RecordedCommand.hh"
#include <bitset>
#include <memory>
#include <optional>
 
namespace openmsx {
 
class DeviceConfig;
class IDECDROM;
 
class CDXCommand final : public RecordedCommand
{
public:
        CDXCommand(CommandController& commandController,
                   StateChangeDistributor& stateChangeDistributor,
                   Scheduler& scheduler, IDECDROM& cd);
        void execute(std::span<const TclObject> tokens,
                TclObject& result, EmuTime::param time) override;
        [[nodiscard]] std::string help(std::span<const TclObject> tokens) const override;
        void tabCompletion(std::vector<std::string>& tokens) const override;
private:
        IDECDROM& cd;
};
 
class IDECDROM final : public AbstractIDEDevice, public MediaInfoProvider
{
public:
        static constexpr unsigned MAX_CD = 26;
        using CDInUse = std::bitset<MAX_CD>;
        static std::shared_ptr<CDInUse> getDrivesInUse(MSXMotherBoard& motherBoard);
 
public:
        explicit IDECDROM(const DeviceConfig& config);
        IDECDROM(const IDECDROM&) = delete;
        IDECDROM(IDECDROM&&) = delete;
        IDECDROM& operator=(const IDECDROM&) = delete;
        IDECDROM& operator=(IDECDROM&&) = delete;
        ~IDECDROM() override;
 
        void eject();
        void insert(const std::string& filename);
 
        // MediaInfoProvider
        void getMediaInfo(TclObject& result) override;
 
        template<typename Archive>
        void serialize(Archive& ar, unsigned version);
 
protected:
        // AbstractIDEDevice:
        [[nodiscard]] bool isPacketDevice() override;
        [[nodiscard]] std::string_view getDeviceName() override;
        void fillIdentifyBlock (AlignedBuffer& buffer) override;
        [[nodiscard]] unsigned readBlockStart(AlignedBuffer& buffer, unsigned count) override;
        void readEnd() override;
        void writeBlockComplete(AlignedBuffer& buffer, unsigned count) override;
        void executeCommand(byte cmd) override;
 
private:
        // Flags for the interrupt reason register:
        static constexpr byte REL = 0x04;
        static constexpr byte I_O = 0x02;
        static constexpr byte C_D = 0x01;
 
        void startPacketReadTransfer(unsigned count);
 
        void executePacketCommand(AlignedBuffer& packet);
 
        std::string name;
        std::optional<CDXCommand> cdxCommand; // delayed init
        File file;
        unsigned byteCountLimit;
        unsigned transferOffset;
 
        unsigned senseKey;
 
        bool readSectorData;
 
        // Removable Media Status Notification Feature Set
        bool remMedStatNotifEnabled;
        bool mediaChanged;
 
        std::shared_ptr<CDInUse> cdInUse;
 
        friend class CDXCommand;
 
        const std::string devName;
};
 
} // namespace openmsx
 
#endif