AbstractIDEDevice.hh

Go to the documentation of this file.

#ifndef ABSTRACTIDEDEVICE_HH
#define ABSTRACTIDEDEVICE_HH

#include "IDEDevice.hh"
#include "serialize_meta.hh"
#include <string>

namespace openmsx {

class MSXMotherBoard;

class AbstractIDEDevice : public IDEDevice
{
public:
        virtual void reset(EmuTime::param time);

        virtual word readData(EmuTime::param time);
        virtual byte readReg(nibble reg, EmuTime::param time);

        virtual void writeData(word value, EmuTime::param time);
        virtual void writeReg(nibble reg, byte value, EmuTime::param time);

        template<typename Archive>
        void serialize(Archive& ar, unsigned version);

protected:
        // Bit flags for the status register:
        static const byte DRDY = 0x40;
        static const byte DSC = 0x10;
        static const byte DRQ = 0x08;
        static const byte ERR = 0x01;

        // Bit flags for the error register:
        static const byte UNC = 0x40;
        static const byte IDNF = 0x10;
        static const byte ABORT = 0x04;

        explicit AbstractIDEDevice(MSXMotherBoard& motherBoard);
        virtual ~AbstractIDEDevice();

        virtual bool isPacketDevice() = 0;

        virtual const std::string& getDeviceName() = 0;

        virtual void fillIdentifyBlock(byte* buffer) = 0;

        virtual unsigned readBlockStart(byte* buffer, unsigned count) = 0;

        virtual void readEnd();

        virtual void writeBlockComplete(byte* buffer, unsigned count) = 0;

        virtual void executeCommand(byte cmd);

        void setError(byte error);

        unsigned getSectorNumber() const;

        unsigned getNumSectors() const;

        void setInterruptReason(byte value);

        unsigned getByteCount();

        void setByteCount(unsigned count);

        void setSectorNumber(unsigned lba);

        void startLongReadTransfer(unsigned count);

        byte* startShortReadTransfer(unsigned count);

        void abortReadTransfer(byte error);

        void startWriteTransfer(unsigned count);

        void abortWriteTransfer(byte error);

        byte getFeatureReg() const { return featureReg; }
        void setLBALow (byte value) { sectorNumReg    = value; }
        void setLBAMid (byte value) { cylinderLowReg  = value; }
        void setLBAHigh(byte value) { cylinderHighReg = value; }

private:
        byte diagnostic();

        void createSignature(bool preserveDevice = false);

        void createIdentifyBlock(byte* buffer);

        void startReadTransfer();

        void readNextBlock();

        void setTransferRead(bool status);

        void writeNextBlock();

        void setTransferWrite(bool status);

        MSXMotherBoard& motherBoard;

        byte buffer[512];

        unsigned transferIdx;

        unsigned bufferLeft;

        unsigned transferCount;

        // ATA registers:
        byte errorReg;
        byte sectorCountReg;
        byte sectorNumReg;
        byte cylinderLowReg;
        byte cylinderHighReg;
        byte devHeadReg;
        byte statusReg;
        byte featureReg;

        bool transferRead;
        bool transferWrite;
};

REGISTER_BASE_NAME_HELPER(AbstractIDEDevice, "IDEDevice");

} // namespace openmsx

#endif // ABSTRACTIDEDEVICE_HH