390 lines
15 KiB
JavaScript
390 lines
15 KiB
JavaScript
/**
|
|
* @fileoverview Implements the PDP11 ROM component.
|
|
* @author <a href="mailto:Jeff@pcjs.org">Jeff Parsons</a>
|
|
* @copyright © Jeff Parsons 2012-2017
|
|
*
|
|
* This file is part of PCjs, a computer emulation software project at <http://pcjs.org/>.
|
|
*
|
|
* PCjs is free software: you can redistribute it and/or modify it under the terms of the
|
|
* GNU General Public License as published by the Free Software Foundation, either version 3
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* PCjs is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
|
|
* even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along with PCjs. If not,
|
|
* see <http://www.gnu.org/licenses/gpl.html>.
|
|
*
|
|
* You are required to include the above copyright notice in every modified copy of this work
|
|
* and to display that copyright notice when the software starts running; see COPYRIGHT in
|
|
* <http://pcjs.org/modules/shared/lib/defines.js>.
|
|
*
|
|
* Some PCjs files also attempt to load external resource files, such as character-image files,
|
|
* ROM files, and disk image files. Those external resource files are not considered part of PCjs
|
|
* for purposes of the GNU General Public License, and the author does not claim any copyright
|
|
* as to their contents.
|
|
*/
|
|
|
|
"use strict";
|
|
|
|
if (NODE) {
|
|
var Str = require("../../shared/lib/strlib");
|
|
var Web = require("../../shared/lib/weblib");
|
|
var DumpAPI = require("../../shared/lib/dumpapi");
|
|
var Component = require("../../shared/lib/component");
|
|
var PDP11 = require("./defines");
|
|
var BusPDP11 = require("./bus");
|
|
var MemoryPDP11 = require("./memory");
|
|
var MessagesPDP11 = require("./messages");
|
|
}
|
|
|
|
class ROMPDP11 extends Component {
|
|
/**
|
|
* ROMPDP11(parmsROM)
|
|
*
|
|
* The ROMPDP11 component expects the following (parmsROM) properties:
|
|
*
|
|
* addr: physical address of ROM
|
|
* size: amount of ROM, in bytes
|
|
* alias: physical alias address (null if none)
|
|
* file: name of ROM data file
|
|
*
|
|
* NOTE: The ROM data will not be copied into place until the Bus is ready (see initBus()) AND
|
|
* the ROM data file has finished loading (see finishLoad()).
|
|
*
|
|
* Also, while the size parameter may seem redundant, I consider it useful to confirm that the ROM
|
|
* you received is the ROM you expected.
|
|
*
|
|
* @param {Object} parmsROM
|
|
*/
|
|
constructor(parmsROM)
|
|
{
|
|
super("ROM", parmsROM, MessagesPDP11.ROM);
|
|
|
|
this.abInit = null;
|
|
this.aSymbols = null;
|
|
|
|
this.addrROM = +parmsROM['addr'];
|
|
this.sizeROM = +parmsROM['size'];
|
|
this.fRetainROM = false;
|
|
|
|
/*
|
|
* The new 'alias' property can now be EITHER a single physical address (like 'addr') OR an array of
|
|
* physical addresses; eg:
|
|
*
|
|
* [0xf0000,0xffff0000,0xffff8000]
|
|
*
|
|
* We could have overloaded 'addr' to accomplish the same thing, but I think it's better to have any
|
|
* aliased locations listed under a separate property.
|
|
*
|
|
* Most ROMs are not aliased, in which case the 'alias' property should have the default value of null.
|
|
*/
|
|
this.addrAlias = parmsROM['alias'];
|
|
if (typeof this.addrAlias == "string") {
|
|
this.addrAlias = eval(this.addrAlias);
|
|
}
|
|
|
|
this.sFilePath = parmsROM['file'];
|
|
this.sFileName = Str.getBaseName(this.sFilePath);
|
|
|
|
if (this.sFilePath) {
|
|
var sFileURL = this.sFilePath;
|
|
if (DEBUG) this.log('load("' + sFileURL + '")');
|
|
/*
|
|
* If the selected ROM file has a ".json" extension, then we assume it's pre-converted
|
|
* JSON-encoded ROM data, so we load it as-is; ditto for ROM files with a ".hex" extension.
|
|
* Otherwise, we ask our server-side ROM converter to return the file in a JSON-compatible format.
|
|
*/
|
|
var sFileExt = Str.getExtension(this.sFileName);
|
|
if (sFileExt != DumpAPI.FORMAT.JSON && sFileExt != DumpAPI.FORMAT.HEX) {
|
|
sFileURL = Web.getHost() + DumpAPI.ENDPOINT + '?' + DumpAPI.QUERY.FILE + '=' + this.sFilePath + '&' + DumpAPI.QUERY.FORMAT + '=' + DumpAPI.FORMAT.BYTES + '&' + DumpAPI.QUERY.DECIMAL + '=true';
|
|
}
|
|
var rom = this;
|
|
Web.getResource(sFileURL, null, true, function doneLoad(sURL, sResponse, nErrorCode) {
|
|
rom.finishLoad(sURL, sResponse, nErrorCode);
|
|
});
|
|
}
|
|
}
|
|
|
|
/**
|
|
* initBus(cmp, bus, cpu, dbg)
|
|
*
|
|
* @this {ROMPDP11}
|
|
* @param {ComputerPDP11} cmp
|
|
* @param {BusPDP11} bus
|
|
* @param {CPUStatePDP11} cpu
|
|
* @param {DebuggerPDP11} dbg
|
|
*/
|
|
initBus(cmp, bus, cpu, dbg)
|
|
{
|
|
this.bus = bus;
|
|
this.cpu = cpu;
|
|
this.dbg = dbg;
|
|
this.initROM();
|
|
}
|
|
|
|
/**
|
|
* powerUp(data, fRepower)
|
|
*
|
|
* @this {ROMPDP11}
|
|
* @param {Object|null} data
|
|
* @param {boolean} [fRepower]
|
|
* @return {boolean} true if successful, false if failure
|
|
*/
|
|
powerUp(data, fRepower)
|
|
{
|
|
if (this.aSymbols) {
|
|
if (this.dbg) {
|
|
this.dbg.addSymbols(this.id, this.addrROM, this.sizeROM, this.aSymbols);
|
|
}
|
|
/*
|
|
* Our only role in the handling of symbols is to hand them off to the Debugger at our
|
|
* first opportunity. Now that we've done that, our copy of the symbols, if any, are toast.
|
|
*/
|
|
delete this.aSymbols;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* powerDown(fSave, fShutdown)
|
|
*
|
|
* Since we have nothing to do on powerDown(), and no state to return, we could simply omit
|
|
* this function. But it doesn't hurt anything, and maybe we'll use our state to save something
|
|
* useful down the road, like user-defined symbols (ie, symbols that the Debugger may have
|
|
* created, above and beyond those symbols we automatically loaded, if any, along with the ROM).
|
|
*
|
|
* @this {ROMPDP11}
|
|
* @param {boolean} [fSave]
|
|
* @param {boolean} [fShutdown]
|
|
* @return {Object|boolean} component state if fSave; otherwise, true if successful, false if failure
|
|
*/
|
|
powerDown(fSave, fShutdown)
|
|
{
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* finishLoad(sURL, sData, nErrorCode)
|
|
*
|
|
* @this {ROMPDP11}
|
|
* @param {string} sURL
|
|
* @param {string} sData
|
|
* @param {number} nErrorCode (response from server if anything other than 200)
|
|
*/
|
|
finishLoad(sURL, sData, nErrorCode)
|
|
{
|
|
if (nErrorCode) {
|
|
this.notice("Unable to load ROM resource (error " + nErrorCode + ": " + sURL + ")");
|
|
this.sFilePath = null;
|
|
}
|
|
else {
|
|
Component.addMachineResource(this.idMachine, sURL, sData);
|
|
var resource = Web.parseMemoryResource(sURL, sData);
|
|
if (resource) {
|
|
this.abInit = resource.aBytes;
|
|
this.aSymbols = resource.aSymbols;
|
|
} else {
|
|
this.sFilePath = null;
|
|
}
|
|
}
|
|
this.initROM();
|
|
}
|
|
|
|
/**
|
|
* initROM()
|
|
*
|
|
* This function is called by both initBus() and finishLoad(), but it cannot copy the initial data into place
|
|
* until after initBus() has received the Bus component AND finishLoad() has received the data. When both those
|
|
* criteria are satisfied, the component becomes "ready".
|
|
*
|
|
* @this {ROMPDP11}
|
|
*/
|
|
initROM()
|
|
{
|
|
if (!this.isReady()) {
|
|
if (this.sFilePath) {
|
|
/*
|
|
* Too early...
|
|
*/
|
|
if (!this.abInit || !this.bus) return;
|
|
|
|
/*
|
|
* If no explicit size was specified, then use whatever the actual size is.
|
|
*/
|
|
if (!this.sizeROM) {
|
|
this.sizeROM = this.abInit.length;
|
|
}
|
|
if (this.abInit.length != this.sizeROM) {
|
|
/*
|
|
* Note that setError() sets the component's fError flag, which in turn prevents setReady() from
|
|
* marking the component ready. TODO: Revisit this decision. On the one hand, it sounds like a
|
|
* good idea to stop the machine in its tracks whenever a setError() occurs, but there may also be
|
|
* times when we'd like to forge ahead anyway.
|
|
*/
|
|
this.setError("ROM size (" + Str.toHexLong(this.abInit.length) + ") does not match specified size (" + Str.toHexLong(this.sizeROM) + ")");
|
|
}
|
|
else if (this.addROM(this.addrROM)) {
|
|
|
|
var aliases = [];
|
|
if (typeof this.addrAlias == "number") {
|
|
aliases.push(this.addrAlias);
|
|
} else if (this.addrAlias != null && this.addrAlias.length) {
|
|
aliases = this.addrAlias;
|
|
}
|
|
for (var i = 0; i < aliases.length; i++) {
|
|
this.cloneROM(aliases[i]);
|
|
}
|
|
/*
|
|
* We used to hang onto the initial ROM data so that we could restore any bytes the CPU overwrote,
|
|
* using memory write-notification handlers, but with the introduction of read-only memory blocks, that's
|
|
* no longer necessary.
|
|
*
|
|
* TODO: Consider an option to retain the ROM data, and give the user some way of restoring ROMs.
|
|
* That may be useful for "resumable" machines that save/restore all dirty block of memory, regardless
|
|
* whether they're ROM or RAM. However, the only way to modify a machine's ROM is with the Debugger,
|
|
* and Debugger users should know better.
|
|
*/
|
|
if (!this.fRetainROM) {
|
|
delete this.abInit;
|
|
}
|
|
}
|
|
}
|
|
this.setReady();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* addROM(addr)
|
|
*
|
|
* @this {ROMPDP11}
|
|
* @param {number} addr
|
|
* @return {boolean}
|
|
*/
|
|
addROM(addr)
|
|
{
|
|
if (addr >= BusPDP11.IOPAGE_16BIT && addr < BusPDP11.IOPAGE_16BIT + BusPDP11.IOPAGE_LENGTH) {
|
|
/*
|
|
* This code has been added as a work-around to effectively allow us to install small ROMs into portions
|
|
* of the IOPAGE address space, by installing I/O handlers for the entire range that return the corresponding
|
|
* bytes of the current ROM image on reads, and ignore any writes (which I'm only assuming is how a typical
|
|
* ROM "device" deals with writes; we could remove the write handler, but then writes would fault).
|
|
*
|
|
* TODO: It would be more efficient if we parsed ROM data as words rather than bytes, and then installed
|
|
* only word handlers instead of only byte handlers. It was done this way purely for historical reasons (ie,
|
|
* because that's how other PCjs machines parse their ROMs). For now, all this means is that executing code
|
|
* out of ROM will be slower than out of RAM -- although that's often true in the real world as well.
|
|
*/
|
|
var IOTable = {
|
|
[addr]: [ROMPDP11.prototype.readROMByte, ROMPDP11.prototype.writeROMByte, null, null, null, this.sizeROM >> 1]
|
|
};
|
|
if (this.bus.addIOTable(this, IOTable)) {
|
|
this.status("Added " + this.sizeROM + "-byte ROM at " + Str.toOct(addr));
|
|
this.fRetainROM = true;
|
|
return true;
|
|
}
|
|
}
|
|
else if (this.bus.addMemory(addr, this.sizeROM, MemoryPDP11.TYPE.ROM)) {
|
|
if (DEBUG) this.log("addROM(): copying ROM to " + Str.toHexLong(addr) + " (" + Str.toHexLong(this.abInit.length) + " bytes)");
|
|
var i;
|
|
for (i = 0; i < this.abInit.length; i++) {
|
|
this.bus.setByteDirect(addr + i, this.abInit[i]);
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/*
|
|
* We don't need to report an error here, because addMemory() already takes care of that.
|
|
*/
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* cloneROM(addr)
|
|
*
|
|
* For ROMs with one or more alias addresses, we used to call addROM() for each address. However,
|
|
* that obviously wasted memory, since each alias was an independent copy, and if you used the
|
|
* Debugger to edit the ROM in one location, the changes would not appear in the other location(s).
|
|
*
|
|
* Now that the Bus component provides low-level getMemoryBlocks() and setMemoryBlocks() methods
|
|
* to manually get and set the blocks of any memory range, it is now possible to create true aliases.
|
|
*
|
|
* @this {ROMPDP11}
|
|
* @param {number} addr
|
|
*/
|
|
cloneROM(addr)
|
|
{
|
|
var aBlocks = this.bus.getMemoryBlocks(this.addrROM, this.sizeROM);
|
|
this.bus.setMemoryBlocks(addr, this.sizeROM, aBlocks);
|
|
}
|
|
|
|
/**
|
|
* readROMByte(addr)
|
|
*
|
|
* @this {ROMPDP11}
|
|
* @param {number} addr
|
|
* @return {number}
|
|
*/
|
|
readROMByte(addr)
|
|
{
|
|
var i = (addr - this.addrROM);
|
|
return this.abInit[i];
|
|
}
|
|
|
|
/**
|
|
* writeROMByte(data, addr)
|
|
*
|
|
* This handler exists simply to ignore any writes, so that they don't cause faults.
|
|
*
|
|
* TODO: Another possible use for this would be to allow the Debugger to alter ROM contents,
|
|
* if the Debugger were to provide an interface indicating whether or not it was responsible
|
|
* for this write.
|
|
*
|
|
* @this {ROMPDP11}
|
|
* @param {number} data
|
|
* @param {number} addr
|
|
*/
|
|
writeROMByte(data, addr)
|
|
{
|
|
}
|
|
|
|
/**
|
|
* ROMPDP11.init()
|
|
*
|
|
* This function operates on every HTML element of class "rom", extracting the
|
|
* JSON-encoded parameters for the ROMPDP11 constructor from the element's "data-value"
|
|
* attribute, invoking the constructor to create a ROMPDP11 component, and then binding
|
|
* any associated HTML controls to the new component.
|
|
*/
|
|
static init()
|
|
{
|
|
var aeROM = Component.getElementsByClass(document, PDP11.APPCLASS, "rom");
|
|
for (var iROM = 0; iROM < aeROM.length; iROM++) {
|
|
var eROM = aeROM[iROM];
|
|
var parmsROM = Component.getComponentParms(eROM);
|
|
var rom = new ROMPDP11(parmsROM);
|
|
Component.bindComponentControls(rom, eROM, PDP11.APPCLASS);
|
|
}
|
|
}
|
|
}
|
|
|
|
/*
|
|
* NOTE: There's currently no need for this component to have a reset() function, since
|
|
* once the ROM data is loaded, it can't be changed, so there's nothing to reinitialize.
|
|
*
|
|
* OK, well, I take that back, because the Debugger, if installed, has the ability to modify
|
|
* ROM contents, so in that case, having a reset() function that restores the original ROM data
|
|
* might be useful; then again, it might not, depending on what you're trying to debug.
|
|
*
|
|
* If we do add reset(), then we'll want to change initROM() to hang onto the original
|
|
* ROM data; currently, we release it after copying it into the read-only memory allocated
|
|
* via bus.addMemory().
|
|
*/
|
|
|
|
/*
|
|
* Initialize all the ROMPDP11 modules on the page.
|
|
*/
|
|
Web.onInit(ROMPDP11.init);
|
|
|
|
if (NODE) module.exports = ROMPDP11;
|