mirror of
https://github.com/TomHarte/CLK.git
synced 2024-06-01 22:41:32 +00:00
303 lines
11 KiB
C++
303 lines
11 KiB
C++
//
|
|
// StaticAnalyser.cpp
|
|
// Clock Signal
|
|
//
|
|
// Created by Thomas Harte on 25/11/2017.
|
|
// Copyright 2017 Thomas Harte. All rights reserved.
|
|
//
|
|
|
|
#include "StaticAnalyser.hpp"
|
|
|
|
#include "Cartridge.hpp"
|
|
#include "Tape.hpp"
|
|
#include "Target.hpp"
|
|
|
|
#include "../Disassembler/Z80.hpp"
|
|
#include "../Disassembler/AddressMapper.hpp"
|
|
|
|
#include <algorithm>
|
|
|
|
static std::unique_ptr<Analyser::Static::Target> CartridgeTarget(
|
|
const Storage::Cartridge::Cartridge::Segment &segment,
|
|
uint16_t start_address,
|
|
Analyser::Static::MSX::Cartridge::Type type,
|
|
float confidence) {
|
|
|
|
// Size down to a multiple of 8kb in size and apply the start address.
|
|
std::vector<Storage::Cartridge::Cartridge::Segment> output_segments;
|
|
if(segment.data.size() & 0x1fff) {
|
|
std::vector<uint8_t> truncated_data;
|
|
std::vector<uint8_t>::difference_type truncated_size = std::vector<uint8_t>::difference_type(segment.data.size()) & ~0x1fff;
|
|
truncated_data.insert(truncated_data.begin(), segment.data.begin(), segment.data.begin() + truncated_size);
|
|
output_segments.emplace_back(start_address, truncated_data);
|
|
} else {
|
|
output_segments.emplace_back(start_address, segment.data);
|
|
}
|
|
|
|
auto target = std::make_unique<Analyser::Static::MSX::Target>();
|
|
target->confidence = confidence;
|
|
|
|
if(type == Analyser::Static::MSX::Cartridge::Type::None) {
|
|
target->media.cartridges.emplace_back(new Storage::Cartridge::Cartridge(output_segments));
|
|
} else {
|
|
target->media.cartridges.emplace_back(new Analyser::Static::MSX::Cartridge(output_segments, type));
|
|
}
|
|
|
|
return target;
|
|
}
|
|
|
|
/*
|
|
Expected standard cartridge format:
|
|
|
|
DEFB "AB" ; expansion ROM header
|
|
DEFW initcode ; start of the init code, 0 if no initcode
|
|
DEFW callstat; pointer to CALL statement handler, 0 if no such handler
|
|
DEFW device; pointer to expansion device handler, 0 if no such handler
|
|
DEFW basic ; pointer to the start of a tokenized basicprogram, 0 if no basicprogram
|
|
DEFS 6,0 ; room reserved for future extensions
|
|
|
|
MSX cartridges often include banking hardware; those games were marketed as MegaROMs. The file
|
|
format that the MSX community has decided upon doesn't retain the type of hardware included, so
|
|
this analyser has to guess.
|
|
|
|
(additional audio hardware is also sometimes included, but it's implied by the banking hardware)
|
|
*/
|
|
static Analyser::Static::TargetList CartridgeTargetsFrom(
|
|
const std::vector<std::shared_ptr<Storage::Cartridge::Cartridge>> &cartridges) {
|
|
// No cartridges implies no targets.
|
|
if(cartridges.empty()) {
|
|
return {};
|
|
}
|
|
|
|
Analyser::Static::TargetList targets;
|
|
for(const auto &cartridge : cartridges) {
|
|
const auto &segments = cartridge->get_segments();
|
|
|
|
// Only one mapped item is allowed.
|
|
if(segments.size() != 1) continue;
|
|
|
|
// Which must be no more than 63 bytes larger than a multiple of 8 kb in size.
|
|
Storage::Cartridge::Cartridge::Segment segment = segments.front();
|
|
const size_t data_size = segment.data.size();
|
|
if(data_size < 0x2000 || (data_size & 0x1fff) > 64) continue;
|
|
|
|
// Check for a ROM header at address 0; if it's not found then try 0x4000
|
|
// and adjust the start address;
|
|
uint16_t start_address = 0;
|
|
bool found_start = false;
|
|
if(segment.data[0] == 0x41 && segment.data[1] == 0x42) {
|
|
start_address = 0x4000;
|
|
found_start = true;
|
|
} else if(segment.data.size() >= 0x8000 && segment.data[0x4000] == 0x41 && segment.data[0x4001] == 0x42) {
|
|
start_address = 0;
|
|
found_start = true;
|
|
}
|
|
|
|
// Reject cartridge if the ROM header wasn't found.
|
|
if(!found_start) continue;
|
|
|
|
uint16_t init_address = uint16_t(segment.data[2] | (segment.data[3] << 8));
|
|
// TODO: check for a rational init address?
|
|
|
|
// If this ROM is less than 48kb in size then it's an ordinary ROM. Just emplace it and move on.
|
|
if(data_size <= 0xc000) {
|
|
targets.emplace_back(CartridgeTarget(segment, start_address, Analyser::Static::MSX::Cartridge::Type::None, 1.0));
|
|
continue;
|
|
}
|
|
|
|
// If this ROM is greater than 48kb in size then some sort of MegaROM scheme must
|
|
// be at play; disassemble to try to figure it out.
|
|
std::vector<uint8_t> first_8k;
|
|
first_8k.insert(first_8k.begin(), segment.data.begin(), segment.data.begin() + 8192);
|
|
Analyser::Static::Z80::Disassembly disassembly =
|
|
Analyser::Static::Z80::Disassemble(
|
|
first_8k,
|
|
Analyser::Static::Disassembler::OffsetMapper(start_address),
|
|
{ init_address }
|
|
);
|
|
|
|
// // Look for a indirect store followed by an unconditional JP or CALL into another
|
|
// // segment, that's a fairly explicit sign where found.
|
|
using Instruction = Analyser::Static::Z80::Instruction;
|
|
std::map<uint16_t, Instruction> &instructions = disassembly.instructions_by_address;
|
|
bool is_ascii = false;
|
|
// auto iterator = instructions.begin();
|
|
// while(iterator != instructions.end()) {
|
|
// auto next_iterator = iterator;
|
|
// next_iterator++;
|
|
// if(next_iterator == instructions.end()) break;
|
|
//
|
|
// if( iterator->second.operation == Instruction::Operation::LD &&
|
|
// iterator->second.destination == Instruction::Location::Operand_Indirect &&
|
|
// (
|
|
// iterator->second.operand == 0x5000 ||
|
|
// iterator->second.operand == 0x6000 ||
|
|
// iterator->second.operand == 0x6800 ||
|
|
// iterator->second.operand == 0x7000 ||
|
|
// iterator->second.operand == 0x77ff ||
|
|
// iterator->second.operand == 0x7800 ||
|
|
// iterator->second.operand == 0x8000 ||
|
|
// iterator->second.operand == 0x9000 ||
|
|
// iterator->second.operand == 0xa000
|
|
// ) &&
|
|
// (
|
|
// next_iterator->second.operation == Instruction::Operation::CALL ||
|
|
// next_iterator->second.operation == Instruction::Operation::JP
|
|
// ) &&
|
|
// ((next_iterator->second.operand >> 13) != (0x4000 >> 13))
|
|
// ) {
|
|
// const uint16_t address = uint16_t(next_iterator->second.operand);
|
|
// switch(iterator->second.operand) {
|
|
// case 0x6000:
|
|
// if(address >= 0x6000 && address < 0x8000) {
|
|
// target.msx.cartridge_type = Analyser::Static::MSXCartridgeType::KonamiWithSCC;
|
|
// }
|
|
// break;
|
|
// case 0x6800:
|
|
// if(address >= 0x6000 && address < 0x6800) {
|
|
// target.msx.cartridge_type = Analyser::Static::MSXCartridgeType::ASCII8kb;
|
|
// }
|
|
// break;
|
|
// case 0x7000:
|
|
// if(address >= 0x6000 && address < 0x8000) {
|
|
// target.msx.cartridge_type = Analyser::Static::MSXCartridgeType::KonamiWithSCC;
|
|
// }
|
|
// if(address >= 0x7000 && address < 0x7800) {
|
|
// is_ascii = true;
|
|
// }
|
|
// break;
|
|
// case 0x77ff:
|
|
// if(address >= 0x7000 && address < 0x7800) {
|
|
// target.msx.cartridge_type = Analyser::Static::MSXCartridgeType::ASCII16kb;
|
|
// }
|
|
// break;
|
|
// case 0x7800:
|
|
// if(address >= 0xa000 && address < 0xc000) {
|
|
// target.msx.cartridge_type = Analyser::Static::MSXCartridgeType::ASCII8kb;
|
|
// }
|
|
// break;
|
|
// case 0x8000:
|
|
// if(address >= 0x8000 && address < 0xa000) {
|
|
// target.msx.cartridge_type = Analyser::Static::MSXCartridgeType::KonamiWithSCC;
|
|
// }
|
|
// break;
|
|
// case 0x9000:
|
|
// if(address >= 0x8000 && address < 0xa000) {
|
|
// target.msx.cartridge_type = Analyser::Static::MSXCartridgeType::KonamiWithSCC;
|
|
// }
|
|
// break;
|
|
// case 0xa000:
|
|
// if(address >= 0xa000 && address < 0xc000) {
|
|
// target.msx.cartridge_type = Analyser::Static::MSXCartridgeType::Konami;
|
|
// }
|
|
// break;
|
|
// case 0xb000:
|
|
// if(address >= 0xa000 && address < 0xc000) {
|
|
// target.msx.cartridge_type = Analyser::Static::MSXCartridgeType::KonamiWithSCC;
|
|
// }
|
|
// break;
|
|
// }
|
|
// }
|
|
//
|
|
// iterator = next_iterator;
|
|
|
|
// Look for LD (nnnn), A instructions, and collate those addresses.
|
|
std::map<uint16_t, int> address_counts;
|
|
for(const auto &instruction_pair : instructions) {
|
|
if( instruction_pair.second.operation == Instruction::Operation::LD &&
|
|
instruction_pair.second.destination == Instruction::Location::Operand_Indirect &&
|
|
instruction_pair.second.source == Instruction::Location::A) {
|
|
address_counts[uint16_t(instruction_pair.second.operand)]++;
|
|
}
|
|
}
|
|
|
|
// Weight confidences by number of observed hits.
|
|
float total_hits =
|
|
float(
|
|
address_counts[0x6000] + address_counts[0x6800] +
|
|
address_counts[0x7000] + address_counts[0x7800] +
|
|
address_counts[0x77ff] + address_counts[0x8000] +
|
|
address_counts[0xa000] + address_counts[0x5000] +
|
|
address_counts[0x9000] + address_counts[0xb000]
|
|
);
|
|
|
|
targets.push_back(CartridgeTarget(
|
|
segment,
|
|
start_address,
|
|
Analyser::Static::MSX::Cartridge::ASCII8kb,
|
|
float( address_counts[0x6000] +
|
|
address_counts[0x6800] +
|
|
address_counts[0x7000] +
|
|
address_counts[0x7800]) / total_hits));
|
|
targets.push_back(CartridgeTarget(
|
|
segment,
|
|
start_address,
|
|
Analyser::Static::MSX::Cartridge::ASCII16kb,
|
|
float( address_counts[0x6000] +
|
|
address_counts[0x7000] +
|
|
address_counts[0x77ff]) / total_hits));
|
|
if(!is_ascii) {
|
|
targets.push_back(CartridgeTarget(
|
|
segment,
|
|
start_address,
|
|
Analyser::Static::MSX::Cartridge::Konami,
|
|
float( address_counts[0x6000] +
|
|
address_counts[0x8000] +
|
|
address_counts[0xa000]) / total_hits));
|
|
}
|
|
if(!is_ascii) {
|
|
targets.push_back(CartridgeTarget(
|
|
segment,
|
|
start_address,
|
|
Analyser::Static::MSX::Cartridge::KonamiWithSCC,
|
|
float( address_counts[0x5000] +
|
|
address_counts[0x7000] +
|
|
address_counts[0x9000] +
|
|
address_counts[0xb000]) / total_hits));
|
|
}
|
|
}
|
|
|
|
return targets;
|
|
}
|
|
|
|
Analyser::Static::TargetList Analyser::Static::MSX::GetTargets(const Media &media, const std::string &, TargetPlatform::IntType) {
|
|
TargetList destination;
|
|
|
|
// Append targets for any cartridges that look correct.
|
|
auto cartridge_targets = CartridgeTargetsFrom(media.cartridges);
|
|
std::move(cartridge_targets.begin(), cartridge_targets.end(), std::back_inserter(destination));
|
|
|
|
// Consider building a target for disks and/or tapes.
|
|
auto target = std::make_unique<Target>();
|
|
|
|
// Check tapes for loadable files.
|
|
for(auto &tape : media.tapes) {
|
|
std::vector<File> files_on_tape = GetFiles(tape);
|
|
if(!files_on_tape.empty()) {
|
|
switch(files_on_tape.front().type) {
|
|
case File::Type::ASCII: target->loading_command = "RUN\"CAS:\r"; break;
|
|
case File::Type::TokenisedBASIC: target->loading_command = "CLOAD\rRUN\r"; break;
|
|
case File::Type::Binary: target->loading_command = "BLOAD\"CAS:\",R\r"; break;
|
|
default: break;
|
|
}
|
|
target->media.tapes.push_back(tape);
|
|
}
|
|
}
|
|
|
|
// Region selection: for now, this as simple as:
|
|
// "If a tape is involved, be European. Otherwise be American (i.e. English, but 60Hz)".
|
|
target->region = target->media.tapes.empty() ? Target::Region::USA : Target::Region::Europe;
|
|
|
|
// Blindly accept disks for now.
|
|
// TODO: how to spot an MSX disk?
|
|
target->media.disks = media.disks;
|
|
target->has_disk_drive = !media.disks.empty();
|
|
|
|
if(!target->media.empty()) {
|
|
target->confidence = 0.5;
|
|
destination.push_back(std::move(target));
|
|
}
|
|
|
|
return destination;
|
|
}
|