mirror of
https://github.com/TomHarte/CLK.git
synced 2024-12-25 18:30:21 +00:00
62 lines
2.2 KiB
C++
62 lines
2.2 KiB
C++
//
|
|
// ROMMachine.hpp
|
|
// Clock Signal
|
|
//
|
|
// Created by Thomas Harte on 07/11/2017.
|
|
// Copyright 2017 Thomas Harte. All rights reserved.
|
|
//
|
|
|
|
#ifndef ROMMachine_hpp
|
|
#define ROMMachine_hpp
|
|
|
|
#include <functional>
|
|
#include <memory>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
namespace ROMMachine {
|
|
|
|
/*!
|
|
Describes a ROM image; this term is used in this emulator strictly in the sense of firmware —
|
|
system software that is an inherent part of a machine.
|
|
*/
|
|
struct ROM {
|
|
/// The machine with which this ROM is associated, in a form that is safe for using as
|
|
/// part of a file name.
|
|
std::string machine_name;
|
|
/// A descriptive name for this ROM, suitable for use in a bullet-point list, a bracket
|
|
/// clause, etc, e.g. "the Electron MOS 1.0".
|
|
std::string descriptive_name;
|
|
/// An idiomatic file name for this ROM, e.g. "os10.rom".
|
|
std::string file_name;
|
|
/// The expected size of this ROM in bytes, e.g. 32768.
|
|
size_t size = 0;
|
|
/// CRC32s for all known acceptable copies of this ROM; intended to allow a host platform
|
|
/// to test user-provided ROMs of unknown provenance. **Not** intended to be used
|
|
/// to exclude ROMs where the user's intent is otherwise clear.
|
|
std::vector<uint32_t> crc32s;
|
|
|
|
ROM(std::string machine_name, std::string descriptive_name, std::string file_name, size_t size, uint32_t crc32) :
|
|
machine_name(machine_name), descriptive_name(descriptive_name), file_name(file_name), size(size), crc32s({crc32}) {}
|
|
ROM(std::string machine_name, std::string descriptive_name, std::string file_name, size_t size, std::initializer_list<uint32_t> crc32s) :
|
|
machine_name(machine_name), descriptive_name(descriptive_name), file_name(file_name), size(size), crc32s(crc32s) {}
|
|
};
|
|
|
|
/*!
|
|
Defines the signature for a function that must be supplied by the host environment in order to give machines
|
|
a route for fetching any system ROMs they might need.
|
|
|
|
The caller will supply a vector of the names of ROM files that it would like to inspect. The recevier should
|
|
return a vector of unique_ptrs that either contain the contents of the ROM from @c names that corresponds by
|
|
index, or else are @c nullptr.
|
|
*/
|
|
typedef std::function<std::vector<std::unique_ptr<std::vector<uint8_t>>>(const std::vector<ROM> &roms)> ROMFetcher;
|
|
|
|
enum class Error {
|
|
MissingROMs
|
|
};
|
|
|
|
}
|
|
|
|
#endif /* ROMMachine_h */
|