AmdFlash.cc

Go to the documentation of this file.

#include "AmdFlash.hh"
#include "Rom.hh"
#include "SRAM.hh"
#include "MSXMotherBoard.hh"
#include "MSXCPU.hh"
#include "MSXDevice.hh"
#include "MSXCliComm.hh"
#include "MSXException.hh"
#include "narrow.hh"
#include "one_of.hh"
#include "ranges.hh"
#include "serialize.hh"
#include "serialize_stl.hh"
#include "stl.hh"
#include "xrange.hh"
#include <bit>
#include <cassert>
#include <iterator>
#include <memory>
 
namespace openmsx {
 
AmdFlash::AmdFlash(const Rom& rom, const ValidatedChip& validatedChip,
                   std::span<const bool> writeProtectSectors,
                   const DeviceConfig& config)
        : AmdFlash(rom.getName() + "_flash", validatedChip, &rom, writeProtectSectors, config)
{
}
 
AmdFlash::AmdFlash(const std::string& name, const ValidatedChip& validatedChip,
                   std::span<const bool> writeProtectSectors,
                   const DeviceConfig& config)
        : AmdFlash(name, validatedChip, nullptr, writeProtectSectors, config)
{
}
 
AmdFlash::AmdFlash(const std::string& name, const ValidatedChip& validatedChip,
                   const Rom* rom, std::span<const bool> writeProtectSectors,
                   const DeviceConfig& config)
        : motherBoard(config.getMotherBoard())
        , chip(validatedChip.chip)
{
        assert(writeProtectSectors.size() <= chip.geometry.sectorCount);
 
        sectors.reserve(chip.geometry.sectorCount);
        for (size_t address = 0; const Region& region : chip.geometry.regions) {
                for (size_t regionSector = 0; regionSector < region.count; ++regionSector, address += region.size) {
                        sectors.push_back({
                                .address = address,
                                .size = region.size,
                                .writeProtect = sectors.size() < writeProtectSectors.size() && writeProtectSectors[sectors.size()]
                        });
                }
        }
 
        size_t writableSize = 0;
        size_t readOnlySize = 0;
        for (Sector& sector : sectors) {
                if (sector.writeProtect) {
                        sector.writeAddress = -1;
                        readOnlySize += sector.size;
                } else {
                        sector.writeAddress = narrow<ptrdiff_t>(writableSize);
                        writableSize += sector.size;
                }
        }
        assert((writableSize + readOnlySize) == size());
 
        bool loaded = false;
        if (writableSize) {
                ram = std::make_unique<SRAM>(
                        name, "flash rom",
                        writableSize, config, nullptr, &loaded);
        }
        if (readOnlySize) {
                // If some part of the flash is read-only we require a ROM
                // constructor parameter.
                assert(rom);
        }
 
        std::unique_ptr<Rom> rom_;
        if (!rom && !loaded) {
                // If we don't have a ROM constructor parameter and there was
                // no sram content loaded (= previous persistent flash
                // content), then try to load some initial content. This
                // represents the original content of the flash when the device
                // ships. This ROM is optional, if it's not found, then the
                // initial flash content is all 0xFF.
                try {
                        rom_ = std::make_unique<Rom>(
                                "", "", // dummy name and description
                                config);
                        rom = rom_.get();
                        config.getCliComm().printInfo(
                                "Loaded initial content for flash ROM from ",
                                rom->getFilename());
                } catch (MSXException& e) {
                        // ignore error
                        assert(rom == nullptr); // 'rom' remains nullptr
                        // only if an actual sha1sum was given, tell the user we failed to use it
                        const auto* romTag = config.getXML()->findChild("rom");
                        const bool initialContentSpecified = romTag && romTag->findChild("sha1");
                        if (initialContentSpecified) {
                                config.getCliComm().printWarning(
                                        "Could not load specified initial content "
                                        "for flash ROM: ", e.getMessage());
                        }
                }
        }
 
        auto romSize = rom ? rom->size() : 0;
        size_t offset = 0;
        for (Sector& sector : sectors) {
                if (sector.writeAddress != -1) { // don't use isWritable() here
                        sector.readAddress = &(*ram)[sector.writeAddress];
                        if (!loaded) {
                                auto* ramPtr = const_cast<uint8_t*>(
                                        &(*ram)[sector.writeAddress]);
                                if (offset >= romSize) {
                                        // completely past end of rom
                                        ranges::fill(std::span{ramPtr, sector.size}, 0xFF);
                                } else if (offset + sector.size >= romSize) {
                                        // partial overlap
                                        auto last = romSize - offset;
                                        auto missing = sector.size - last;
                                        const uint8_t* romPtr = &(*rom)[offset];
                                        ranges::copy(std::span{romPtr, last}, ramPtr);
                                        ranges::fill(std::span{&ramPtr[last], missing}, 0xFF);
                                } else {
                                        // completely before end of rom
                                        const uint8_t* romPtr = &(*rom)[offset];
                                        ranges::copy(std::span{romPtr, sector.size}, ramPtr);
                                }
                        }
                } else {
                        assert(rom); // must have rom constructor parameter
                        if ((offset + sector.size) <= romSize) {
                                sector.readAddress = &(*rom)[offset];
                        } else {
                                sector.readAddress = nullptr;
                        }
                }
                offset += sector.size;
        }
        assert(offset == size());
 
        reset();
}
 
AmdFlash::~AmdFlash() = default;
 
size_t AmdFlash::getSectorIndex(size_t address) const
{
        size_t sectorIndex = 0;
        for (const Region& region : chip.geometry.regions) {
                if (address < region.count * region.size) {
                        return sectorIndex + address / region.size;
                } else {
                        address -= region.count * region.size;
                        sectorIndex += region.count;
                }
        }
        UNREACHABLE;
}
 
void AmdFlash::reset()
{
        status = 0x80;
        softReset();
}
 
void AmdFlash::softReset()
{
        cmd.clear();
        setState(State::IDLE);
        status &= 0xC4; // clear status
}
 
void AmdFlash::setState(State newState)
{
        if (state == newState) return;
        state = newState;
        motherBoard.getCPU().invalidateAllSlotsRWCache(0x0000, 0x10000);
}
 
uint8_t AmdFlash::peek(size_t address) const
{
        address %= size();
        if (state == State::IDLE) {
                const Sector& sector = getSector(address);
                if (const uint8_t* addr = sector.readAddress) {
                        return addr[address - sector.address];
                } else {
                        return 0xFF;
                }
        } else if (state == State::IDENT) {
                if (chip.geometry.deviceInterface == DeviceInterface::x8x16) {
                        if (chip.autoSelect.oddZero && (address & 1)) {
                                // some devices return zero for odd bits instead of mirroring
                                return 0x00;
                        }
                        // convert byte address to native address
                        address >>= 1;
                }
                return narrow_cast<uint8_t>(peekAutoSelect(address, chip.autoSelect.undefined));
        } else if (state == State::CFI) {
                if (chip.geometry.deviceInterface == DeviceInterface::x8x16) {
                        // convert byte address to native address
                        const uint16_t result = peekCFI(address >> 1);
                        return narrow_cast<uint8_t>(address & 1 ? result >> 8 : result);
                } else {
                        return narrow_cast<uint8_t>(peekCFI(address));
                }
        } else if (state == one_of(State::STATUS, State::PRGERR)) {
                return status;
        } else {
                UNREACHABLE;
        }
}
 
uint16_t AmdFlash::peekAutoSelect(size_t address, uint16_t undefined) const
{
        switch (address & chip.autoSelect.readMask) {
        case 0x0:
                return to_underlying(chip.autoSelect.manufacturer);
        case 0x1:
                return chip.autoSelect.device.size() == 1 ? chip.autoSelect.device[0] | 0x2200 : 0x227E;
        case 0x2:
                if (chip.geometry.deviceInterface == DeviceInterface::x8x16) {
                        // convert native address to byte address
                        address <<= 1;
                }
                return isWritable(getSector(address)) ? 0 : 1;
        case 0x3:
                // On AM29F040 it indicates "Autoselect Device Unprotect Code".
                // Datasheet does not elaborate. Value is 0x01 according to
                //  https://www.msx.org/forum/semi-msx-talk/emulation/matra-ink-emulated
                //
                // On M29W640G it indicates "Extended Block Verify Code".
                // Bit 7: 0: Extended memory block not factory locked
                //        1: Extended memory block factory locked
                // Other bits are 0x18 on GL, GT and GB models, and 0x01 on GH model.
                // Datasheet does not explain their meaning.
                // Actual value is 0x08 on GB model (verified on hardware).
                //
                // On S29GL064S it indicates "Secure Silicon Region Factory Protect":
                // Bit 4: 0: WP# protects lowest address (bottom boot)
                //        1: WP# protects highest address (top boot)
                // Bit 7: 0: Secure silicon region not factory locked
                //        1: Secure silicon region factory locked
                // Other bits are 0xFF0A. Datasheet does not explain their meaning.
                //
                // On Alliance Memory AS29CF160B it indicates Continuation ID.
                // Datasheet does not elaborate. Value is 0x7F.
                return chip.autoSelect.extraCode;
        case 0xE:
                return chip.autoSelect.device.size() == 2 ? chip.autoSelect.device[0] | 0x2200 : undefined;
        case 0xF:
                return chip.autoSelect.device.size() == 2 ? chip.autoSelect.device[1] | 0x2200 : undefined;
        default:
                // some devices return zero instead of 0xFFFF (typical)
                return undefined;
        }
}
 
uint16_t AmdFlash::peekCFI(size_t address) const
{
        const size_t maskedAddress = address & chip.cfi.readMask;
 
        if (maskedAddress < 0x10) {
                if (chip.cfi.withManufacturerDevice) {
                        // M29W640GB exposes manufacturer & device ID below 0x10 (as 16-bit values)
                        switch (maskedAddress) {
                        case 0x0:
                                return to_underlying(chip.autoSelect.manufacturer);
                        case 0x1:
                                return chip.autoSelect.device.size() == 1 ? chip.autoSelect.device[0] | 0x2200 : 0x227E;
                        case 0x2:
                                return chip.autoSelect.device.size() == 2 ? chip.autoSelect.device[0] | 0x2200 : 0xFFFF;
                        case 0x3:
                                return chip.autoSelect.device.size() == 2 ? chip.autoSelect.device[1] | 0x2200 : 0xFFFF;
                        default:
                                return 0xFFFF;
                        }
                } else if (chip.cfi.withAutoSelect) {
                        // S29GL064S exposes auto select data below 0x10 (as 16-bit values)
                        return peekAutoSelect(address);
                }
        }
 
        switch (maskedAddress) {
        case 0x10:
                return 'Q';
        case 0x11:
                return 'R';
        case 0x12:
                return 'Y';
        case 0x13:
                return 0x02;  // AMD compatible
        case 0x14:
                return 0x00;
        case 0x15:
                return 0x40;
        case 0x16:
        case 0x17:
        case 0x18:
        case 0x19:
        case 0x1A:
                return 0x00;
        case 0x1B:
                return chip.cfi.systemInterface.supply.minVcc;
        case 0x1C:
                return chip.cfi.systemInterface.supply.maxVcc;
        case 0x1D:
                return chip.cfi.systemInterface.supply.minVpp;
        case 0x1E:
                return chip.cfi.systemInterface.supply.maxVpp;
        case 0x1F:
                return chip.cfi.systemInterface.typTimeout.singleProgram.exponent;
        case 0x20:
                return chip.cfi.systemInterface.typTimeout.multiProgram.exponent;
        case 0x21:
                return chip.cfi.systemInterface.typTimeout.sectorErase.exponent;
        case 0x22:
                return chip.cfi.systemInterface.typTimeout.chipErase.exponent;
        case 0x23:
                return chip.cfi.systemInterface.maxTimeoutMult.singleProgram.exponent;
        case 0x24:
                return chip.cfi.systemInterface.maxTimeoutMult.multiProgram.exponent;
        case 0x25:
                return chip.cfi.systemInterface.maxTimeoutMult.sectorErase.exponent;
        case 0x26:
                return chip.cfi.systemInterface.maxTimeoutMult.chipErase.exponent;
        case 0x27:
                return chip.geometry.size.exponent;
        case 0x28:
                return narrow<uint8_t>(to_underlying(chip.geometry.deviceInterface) & 0xFF);
        case 0x29:
                return narrow<uint8_t>(to_underlying(chip.geometry.deviceInterface) >> 8);
        case 0x2A:
                return chip.program.pageSize.exponent;
        case 0x2B:
                return 0x00;
        case 0x2C:
                return narrow<uint8_t>(chip.geometry.regions.size());
        case 0x2D:
        case 0x31:
        case 0x35:
        case 0x39:
                if (const size_t index = (maskedAddress - 0x2D) >> 2; index < chip.geometry.regions.size()) {
                        return narrow<uint8_t>((chip.geometry.regions[index].count - 1) & 0xFF);
                }
                return 0x00;
        case 0x2E:
        case 0x32:
        case 0x36:
        case 0x3A:
                if (const size_t index = (maskedAddress - 0x2E) >> 2; index < chip.geometry.regions.size()) {
                        return narrow<uint8_t>((chip.geometry.regions[index].count - 1) >> 8);
                }
                return 0x00;
        case 0x2F:
        case 0x33:
        case 0x37:
        case 0x3B:
                if (const size_t index = (maskedAddress - 0x2F) >> 2; index < chip.geometry.regions.size()) {
                        return narrow<uint8_t>((chip.geometry.regions[index].size >> 8) & 0xFF);
                }
                return 0x00;
        case 0x30:
        case 0x34:
        case 0x38:
        case 0x3C:
                if (const size_t index = (maskedAddress - 0x30) >> 2; index < chip.geometry.regions.size()) {
                        return narrow<uint8_t>((chip.geometry.regions[index].size >> 8) >> 8);
                }
                return 0x00;
        case 0x40:
                return 'P';
        case 0x41:
                return 'R';
        case 0x42:
                return 'I';
        case 0x43:
                return '0' + chip.cfi.primaryAlgorithm.version.major;
        case 0x44:
                return '0' + chip.cfi.primaryAlgorithm.version.minor;
        case 0x45:
                return narrow<uint8_t>(chip.cfi.primaryAlgorithm.addressSensitiveUnlock | (chip.cfi.primaryAlgorithm.siliconRevision << 2));
        case 0x46:
                return chip.cfi.primaryAlgorithm.eraseSuspend;
        case 0x47:
                return chip.cfi.primaryAlgorithm.sectorProtect;
        case 0x48:
                return chip.cfi.primaryAlgorithm.sectorTemporaryUnprotect;
        case 0x49:
                return chip.cfi.primaryAlgorithm.sectorProtectScheme;
        case 0x4A:
                return chip.cfi.primaryAlgorithm.simultaneousOperation;
        case 0x4B:
                return chip.cfi.primaryAlgorithm.burstMode;
        case 0x4C:
                return chip.cfi.primaryAlgorithm.pageMode;
        case 0x4D:
                return chip.cfi.primaryAlgorithm.version.minor >= 1 ? chip.cfi.primaryAlgorithm.supply.minAcc : 0xFFFF;
        case 0x4E:
                return chip.cfi.primaryAlgorithm.version.minor >= 1 ? chip.cfi.primaryAlgorithm.supply.maxAcc : 0xFFFF;
        case 0x4F:
                return chip.cfi.primaryAlgorithm.version.minor >= 1 ? chip.cfi.primaryAlgorithm.bootBlockFlag : 0xFFFF;
        case 0x50:
                return chip.cfi.primaryAlgorithm.version.minor >= 2 ? chip.cfi.primaryAlgorithm.programSuspend : 0xFFFF;
        default:
                // TODO
                // 0x61-0x64 Unique 64-bit device number / security code for M29W800DB and M29W640GB.
                // M29W640GB also has unknown data in 0x65-0x6A, as well as some in the 0x80-0xFF range.
                return 0xFFFF;
        }
}
 
bool AmdFlash::isWritable(const Sector& sector) const
{
        if (vppWpPinLow) {
                const auto range = chip.geometry.writeProtectPinRange;
                if ((range > 0 && sector <= sectors[range - size_t(1)]) ||
                    (range < 0 && sector >= sectors[range + chip.geometry.sectorCount])) {
                        return false;
                }
        }
        return !sector.writeProtect;
}
 
uint8_t AmdFlash::read(size_t address)
{
        address %= size();
        const uint8_t value = peek(address);
        if (state == State::STATUS) {
                setState(State::IDLE);
        } else if (state == State::PRGERR) {
                status ^= 0x40;
        }
        return value;
}
 
const uint8_t* AmdFlash::getReadCacheLine(size_t address) const
{
        address %= size();
        if (state == State::IDLE) {
                const Sector& sector = getSector(address);
                const uint8_t* addr = sector.readAddress;
                return addr ? &addr[address - sector.address] : MSXDevice::unmappedRead.data();
        } else {
                return nullptr;
        }
}
 
void AmdFlash::write(size_t address, uint8_t value)
{
        address %= size();
        cmd.push_back({address, value});
 
        if (state == State::IDLE) {
                if (checkCommandAutoSelect() ||
                    checkCommandEraseSector() ||
                    checkCommandProgram() ||
                    checkCommandDoubleByteProgram() ||
                    checkCommandQuadrupleByteProgram() ||
                    checkCommandBufferProgram() ||
                    checkCommandEraseChip() ||
                    checkCommandCFIQuery() ||
                    checkCommandContinuityCheck() ||
                    checkCommandStatusRead() ||
                    checkCommandStatusClear() ||
                    checkCommandLongReset() ||
                    checkCommandReset()) {
                        // do nothing, we're still matching a command, but it is not complete yet
                } else {
                        cmd.clear();
                }
        } else if (state == State::IDENT) {
                if (checkCommandCFIQuery() ||
                    checkCommandLongReset() ||
                    checkCommandReset()) {
                        // do nothing, we're still matching a command, but it is not complete yet
                } else {
                        cmd.clear();
                }
        } else if (state == State::CFI) {
                if (checkCommandLongReset() ||
                    checkCommandCFIExit() ||
                    checkCommandReset()) {
                        // do nothing, we're still matching a command, but it is not complete yet
                } else {
                        cmd.clear();
                }
        } else if (state == State::STATUS) {
                // TODO confirm. S29GL064S datasheet: "it is not recommended".
                if (checkCommandLongReset() ||
                    checkCommandReset()) {
                        // do nothing, we're still matching a command, but it is not complete yet
                } else {
                        cmd.clear();
                }
        } else if (state == State::PRGERR) {
                if (checkCommandLongReset() ||
                    (chip.program.shortAbortReset && checkCommandReset())) {
                        // do nothing, we're still matching a command, but it is not complete yet
                } else {
                        cmd.clear();
                }
        } else {
                UNREACHABLE;
        }
}
 
// The checkCommandXXX() methods below return
//   true  -> if the command sequence still matches, but is not complete yet
//   false -> if the command was fully matched or does not match with
//            the current command sequence.
// If there was a full match, the command is also executed.
bool AmdFlash::checkCommandReset()
{
        if (cmd[0].value == 0xf0) {
                softReset();
        }
        return false;
}
 
bool AmdFlash::checkCommandLongReset()
{
        static constexpr std::array<uint8_t, 3> cmdSeq = {0xaa, 0x55, 0xf0};
        if (partialMatch(cmdSeq)) {
                if (cmd.size() < 3) return true;
                softReset();
        }
        return false;
}
 
bool AmdFlash::checkCommandStatusRead()
{
        static constexpr std::array<uint8_t, 1> cmdSeq = {0x70};
        if (chip.misc.statusCommand && partialMatch(cmdSeq)) {
                setState(State::STATUS);
        }
        return false;
}
 
bool AmdFlash::checkCommandStatusClear()
{
        static constexpr std::array<uint8_t, 1> cmdSeq = {0x71};
        if (chip.misc.statusCommand && partialMatch(cmdSeq)) {
                softReset();
        }
        return false;
}
 
bool AmdFlash::checkCommandContinuityCheck()
{
        if (chip.misc.continuityCommand && cmd[0] == AddressValue{0x5554AB, 0xFF}) {
                if (cmd.size() < 2) return true;
                if (cmd.size() == 2 && cmd[1] == AddressValue{0x2AAB54, 0x00}) {
                        status |= 0x01;
                }
        }
        return false;
}
 
bool AmdFlash::checkCommandCFIQuery()
{
        // convert byte address to native address
        const size_t addr = (chip.geometry.deviceInterface == DeviceInterface::x8x16) ? cmd[0].addr >> 1 : cmd[0].addr;
        if (chip.cfi.command && (addr & chip.cfi.commandMask) == 0x55 && cmd[0].value == 0x98) {
                setState(State::CFI);
        }
        return false;
}
 
bool AmdFlash::checkCommandCFIExit()
{
        if (chip.cfi.exitCommand && cmd[0].value == 0xff) {
                softReset();
        }
        return false;
}
 
bool AmdFlash::checkCommandEraseSector()
{
        static constexpr std::array<uint8_t, 5> cmdSeq = {0xaa, 0x55, 0x80, 0xaa, 0x55};
        if (partialMatch(cmdSeq)) {
                if (cmd.size() < 6) return true;
                if (cmd[5].value == 0x30) {
                        if (const Sector& sector = getSector(cmd[5].addr);
                            isWritable(sector)) {
                                ram->memset(sector.writeAddress, 0xff, sector.size);
                        }
 
                        status |= 0x80; // immediate completion
                }
        }
        return false;
}
 
bool AmdFlash::checkCommandEraseChip()
{
        static constexpr std::array<uint8_t, 5> cmdSeq = {0xaa, 0x55, 0x80, 0xaa, 0x55};
        if (partialMatch(cmdSeq)) {
                if (cmd.size() < 6) return true;
                if (cmd[5].value == 0x10) {
                        for (const Sector& sector : sectors) {
                                if (isWritable(sector)) {
                                        ram->memset(sector.writeAddress, 0xff, sector.size);
                                }
                        }
 
                        status |= 0x80; // immediate completion
                }
        }
        return false;
}
 
bool AmdFlash::checkCommandProgramHelper(size_t numBytes, std::span<const uint8_t> cmdSeq)
{
        if (numBytes <= chip.program.pageSize && partialMatch(cmdSeq)) {
                if (cmd.size() < (cmdSeq.size() + numBytes)) return true;
                for (auto i : xrange(cmdSeq.size(), cmdSeq.size() + numBytes)) {
                        const Sector& sector = getSector(cmd[i].addr);
                        if (isWritable(sector)) {
                                auto ramAddr = sector.writeAddress + cmd[i].addr - sector.address;
                                uint8_t ramValue = (*ram)[ramAddr] & cmd[i].value;
                                ram->write(ramAddr, ramValue);
 
                                status = (status & 0x7F) | (ramValue & 0x80); // immediate completion
                        }
                }
        }
        return false;
}
 
bool AmdFlash::checkCommandProgram()
{
        static constexpr std::array<uint8_t, 3> cmdSeq = {0xaa, 0x55, 0xa0};
        return checkCommandProgramHelper(1, cmdSeq);
}
 
bool AmdFlash::checkCommandDoubleByteProgram()
{
        static constexpr std::array<uint8_t, 1> cmdSeq = {0x50};
        return chip.program.fastCommand && checkCommandProgramHelper(2, cmdSeq);
}
 
bool AmdFlash::checkCommandQuadrupleByteProgram()
{
        static constexpr std::array<uint8_t, 1> cmdSeq = {0x56};
        return chip.program.fastCommand && checkCommandProgramHelper(4, cmdSeq);
}
 
bool AmdFlash::checkCommandBufferProgram()
{
        static constexpr std::array<uint8_t, 2> cmdSeq = {0xaa, 0x55};
        if (chip.program.bufferCommand && partialMatch(cmdSeq) && (cmd.size() <= 2 || cmd[2].value == 0x25)) {
                if (cmd.size() <= 3) {
                        return true;
                } else if (cmd.size() <= 4) {
                        if (cmd[3].value < chip.program.pageSize && getSector(cmd[3].addr) == getSector(cmd[2].addr)) {
                                return true;
                        }
                } else if (cmd.size() <= size_t(5 + cmd[3].value)) {
                        const size_t pageMask = ~(chip.program.pageSize - 1);
                        if ((cmd.back().addr & pageMask) == (cmd[4].addr & pageMask)) {
                                status = (status & 0x7F) | (~cmd.back().value & 0x80);
                                return true;
                        }
                } else {
                        const Sector& sector = getSector(cmd[2].addr);
                        if (cmd.back().value == 0x29 && getSector(cmd.back().addr) == sector) {
                                if (isWritable(sector)) {
                                        // TODO de-duplicate same-address writes to the last one
                                        for (auto i : xrange<size_t>(4, cmd.size() - 1)) {
                                                auto ramAddr = sector.writeAddress + cmd[i].addr - sector.address;
                                                uint8_t ramValue = (*ram)[ramAddr] & cmd[i].value;
                                                ram->write(ramAddr, ramValue);
 
                                                status = (status & 0x7F) | (ramValue & 0x80); // immediate completion
                                        }
                                }
                                return false;
                        }
                }
                status = (status & 0xDF) | 0x02;
                setState(State::PRGERR);
        }
        return false;
}
 
bool AmdFlash::checkCommandAutoSelect()
{
        static constexpr std::array<uint8_t, 3> cmdSeq = {0xaa, 0x55, 0x90};
        if (partialMatch(cmdSeq)) {
                if (cmd.size() < 3) return true;
                setState(State::IDENT);
        }
        return false;
}
 
bool AmdFlash::partialMatch(std::span<const uint8_t> dataSeq) const
{
        static constexpr std::array<unsigned, 5> addrSeq = {0, 1, 0, 0, 1};
        static constexpr std::array<unsigned, 2> cmdAddr = {0x555, 0x2aa};
        (void)addrSeq; (void)cmdAddr; // suppress (invalid) gcc warning
 
        assert(dataSeq.size() <= 5);
        return ranges::all_of(xrange(std::min(dataSeq.size(), cmd.size())), [&](auto i) {
                // convert byte address to native address
                auto addr = (chip.geometry.deviceInterface == DeviceInterface::x8x16) ? cmd[i].addr >> 1 : cmd[i].addr;
                return ((addr & 0x7FF) == cmdAddr[addrSeq[i]]) &&
                       (cmd[i].value == dataSeq[i]);
        });
}
 
 
static constexpr std::initializer_list<enum_string<AmdFlash::State>> stateInfo = {
        { "IDLE",   AmdFlash::State::IDLE  },
        { "IDENT",  AmdFlash::State::IDENT },
        { "CFI",    AmdFlash::State::CFI },
        { "STATUS", AmdFlash::State::STATUS },
        { "PRGERR", AmdFlash::State::PRGERR }
};
SERIALIZE_ENUM(AmdFlash::State, stateInfo);
 
template<typename Archive>
void AmdFlash::AddressValue::serialize(Archive& ar, unsigned /*version*/)
{
        ar.serialize("address", addr,
                     "value",   value);
}
 
// version 1: Initial version.
// version 2: Added vppWpPinLow.
// version 3: Changed cmd to static_vector, added status.
template<typename Archive>
void AmdFlash::serialize(Archive& ar, unsigned version)
{
        ar.serialize("ram", *ram);
        if (ar.versionAtLeast(version, 3)) {
                ar.serialize("cmd",    cmd,
                             "status", status);
        } else {
                std::array<AddressValue, 8> cmdArray;
                unsigned cmdSize = 0;
                ar.serialize("cmd",    cmdArray,
                             "cmdIdx", cmdSize);
                cmd = {from_range, subspan(cmdArray, 0, cmdSize)};
        }
        ar.serialize("state", state);
        if (ar.versionAtLeast(version, 2)) {
                ar.serialize("vppWpPinLow", vppWpPinLow);
        }
}
INSTANTIATE_SERIALIZE_METHODS(AmdFlash);
 
} // namespace openmsx