359 lines
13 KiB
JavaScript
359 lines
13 KiB
JavaScript
/**
|
|
* @fileoverview Implements the PCjs ROM component.
|
|
* @author <a href="mailto:Jeff@pcjs.org">Jeff Parsons</a>
|
|
* @version 1.0
|
|
* @suppress {missingProperties}
|
|
* Created 2012-Jun-15
|
|
*
|
|
* Copyright © 2012-2014 Jeff Parsons <Jeff@pcjs.org>
|
|
*
|
|
* This file is part of PCjs, which is part of the JavaScript Machines Project (aka JSMachines)
|
|
* at <http://jsmachines.net/> and <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 source code file of every
|
|
* copy or modified version of this work, and to display that copyright notice on every screen
|
|
* that loads or runs any version of this software (see Computer.sCopyright).
|
|
*
|
|
* 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 the
|
|
* PCjs program for purposes of the GNU General Public License, and the author does not claim
|
|
* any copyright as to their contents.
|
|
*/
|
|
|
|
"use strict";
|
|
|
|
if (typeof module !== 'undefined') {
|
|
var str = require("../../shared/lib/strlib");
|
|
var web = require("../../shared/lib/weblib");
|
|
var DumpAPI = require("../../shared/lib/dumpapi");
|
|
var Component = require("../../shared/lib/component");
|
|
}
|
|
|
|
/**
|
|
* ROM(parmsROM)
|
|
*
|
|
* The ROM 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
|
|
* notify: ID of a component to notify once the ROM is in place (optional)
|
|
*
|
|
* 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 onLoadROM()).
|
|
*
|
|
* Also, while the size parameter may seem redundant, I consider it useful to confirm that the ROM you received
|
|
* is the ROM you expected.
|
|
*
|
|
* @constructor
|
|
* @extends Component
|
|
* @param {Object} parmsROM
|
|
*/
|
|
function ROM(parmsROM)
|
|
{
|
|
Component.call(this, "ROM", parmsROM, ROM);
|
|
|
|
this.abROM = null;
|
|
this.addrROM = parmsROM['addr'];
|
|
this.sizeROM = parmsROM['size'];
|
|
this.addrROMAlias = parmsROM['alias'];
|
|
this.sFileName = parmsROM['file'];
|
|
this.idNotify = parmsROM['notify'];
|
|
if (this.sFileName) {
|
|
var sFileURL = this.sFileName;
|
|
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.sFileName + '&' + DumpAPI.QUERY.FORMAT + '=' + DumpAPI.FORMAT.BYTES + '&' + DumpAPI.QUERY.DECIMAL + '=true';
|
|
}
|
|
web.loadResource(sFileURL, true, null, this, ROM.prototype.onLoadROM);
|
|
}
|
|
}
|
|
|
|
Component.subclass(Component, ROM);
|
|
|
|
/*
|
|
* ROM BIOS Data Area (RBDA) definitions, in physical address form, using the same ALL-CAPS names
|
|
* found in the original IBM PC ROM BIOS listing.
|
|
*
|
|
* TODO: Fill in remaining RBDA holes.
|
|
*/
|
|
ROM.BIOS = {};
|
|
ROM.BIOS.RS232_BASE = 0x400; // 4 (word) I/O addresses of RS-232 adapters
|
|
ROM.BIOS.PRINTER_BASE = 0x408; // 4 (word) I/O addresses of printer adapters
|
|
ROM.BIOS.EQUIP_FLAG = 0x410; // installed hardware (word)
|
|
ROM.BIOS.MFG_TEST = 0x412; // initialization flag (byte)
|
|
ROM.BIOS.MEMORY_SIZE = 0x413; // memory size in K-bytes (word)
|
|
ROM.BIOS.RESET_FLAG = 0x472; // set to 0x1234 if keyboard reset underway (word)
|
|
ROM.BIOS.RESET_FLAG_WARMBOOT = 0x1234; // value stored at ROM.BIOS.RESET_FLAG to indicate a "warm boot", bypassing memory tests
|
|
|
|
// RESET_FLAG is the traditional end of the RBDA, as originally defined at real-mode segment 0x40.
|
|
|
|
/*
|
|
* 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 copyROM() to hang onto the original
|
|
* ROM data; currently, we release it after copying it into the read-only memory allocated
|
|
* via bus.addMemory().
|
|
*/
|
|
|
|
/**
|
|
* initBus(cmp, bus, cpu, dbg)
|
|
*
|
|
* @this {ROM}
|
|
* @param {Computer} cmp
|
|
* @param {Bus} bus
|
|
* @param {X86CPU} cpu
|
|
* @param {Debugger} dbg
|
|
*/
|
|
ROM.prototype.initBus = function(cmp, bus, cpu, dbg)
|
|
{
|
|
this.bus = bus;
|
|
this.cpu = cpu;
|
|
this.dbg = dbg;
|
|
this.copyROM();
|
|
};
|
|
|
|
/**
|
|
* powerUp(data, fRepower)
|
|
*
|
|
* @this {ROM}
|
|
* @param {Object|null} data
|
|
* @param {boolean} [fRepower]
|
|
* @return {boolean} true if successful, false if failure
|
|
*/
|
|
ROM.prototype.powerUp = function(data, fRepower)
|
|
{
|
|
if (this.aSymbols) {
|
|
if (this.dbg) {
|
|
this.dbg.addSymbols(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)
|
|
*
|
|
* 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 {ROM}
|
|
* @param {boolean} fSave
|
|
* @return {Object|boolean}
|
|
*/
|
|
ROM.prototype.powerDown = function(fSave)
|
|
{
|
|
return true;
|
|
};
|
|
|
|
/**
|
|
* onLoadROM(sROMFile, sROMData, nErrorCode)
|
|
*
|
|
* @this {ROM}
|
|
* @param {string} sROMFile
|
|
* @param {string} sROMData
|
|
* @param {number} nErrorCode (response from server if anything other than 200)
|
|
*/
|
|
ROM.prototype.onLoadROM = function(sROMFile, sROMData, nErrorCode)
|
|
{
|
|
if (nErrorCode) {
|
|
this.notice("Unable to load system ROM (error " + nErrorCode + ")");
|
|
return;
|
|
}
|
|
if (sROMData.charAt(0) == "[" || sROMData.charAt(0) == "{") {
|
|
try {
|
|
/*
|
|
* The most likely source of any exception will be here: parsing the JSON-encoded ROM data.
|
|
*/
|
|
var rom = eval("(" + sROMData + ")");
|
|
var ab = rom['bytes'];
|
|
var adw = rom['data'];
|
|
|
|
if (ab) {
|
|
this.abROM = ab;
|
|
}
|
|
else if (adw) {
|
|
/*
|
|
* Convert all the DWORDs into BYTEs, so that subsequent code only has to deal with abROM.
|
|
*/
|
|
this.abROM = new Array(adw.length * 4);
|
|
for (var idw = 0, ib = 0; idw < adw.length; idw++) {
|
|
this.abROM[ib++] = adw[idw] & 0xff;
|
|
this.abROM[ib++] = (adw[idw] >> 8) & 0xff;
|
|
this.abROM[ib++] = (adw[idw] >> 16) & 0xff;
|
|
this.abROM[ib++] = (adw[idw] >> 24) & 0xff;
|
|
}
|
|
}
|
|
else {
|
|
this.abROM = rom;
|
|
}
|
|
|
|
this.aSymbols = rom['symbols'];
|
|
|
|
if (!this.abROM.length) {
|
|
this.error("Empty ROM: " + sROMFile);
|
|
return;
|
|
}
|
|
else if (this.abROM.length == 1) {
|
|
this.error(this.abROM[0]);
|
|
return;
|
|
}
|
|
} catch (e) {
|
|
this.notice("ROM data error: " + e.message);
|
|
return;
|
|
}
|
|
}
|
|
else {
|
|
/*
|
|
* Parse the ROM data manually; we assume it's in "simplified" hex form (a series of hex byte-values
|
|
* separated by whitespace).
|
|
*/
|
|
var sHexData = sROMData.replace(/\n/gm, " ").replace(/ +$/, "");
|
|
var asHexData = sHexData.split(" ");
|
|
this.abROM = new Array(asHexData.length);
|
|
for (var i = 0; i < asHexData.length; i++) {
|
|
this.abROM[i] = parseInt(asHexData[i], 16);
|
|
}
|
|
}
|
|
this.copyROM();
|
|
};
|
|
|
|
/**
|
|
* copyROM()
|
|
*
|
|
* This function is called by both initBus() and onLoadROM(), but it cannot copy the the ROM data into place
|
|
* until after initBus() has received the Bus component AND onloadROM() has received the abROM data. When both
|
|
* those criteria are satisfied, the component becomes "ready".
|
|
*
|
|
* @this {ROM}
|
|
*/
|
|
ROM.prototype.copyROM = function()
|
|
{
|
|
if (!this.isReady()) {
|
|
if (!this.sFileName) {
|
|
this.setReady();
|
|
}
|
|
else if (this.abROM && this.bus) {
|
|
if (this.abROM.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. One 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 (0x" + str.toHex(this.abROM.length) + ") does not match specified size (0x" + str.toHex(this.sizeROM) + ")");
|
|
}
|
|
else if (this.addROM(this.addrROM) && this.addROM(this.addrROMAlias)) {
|
|
/*
|
|
* If there's a component we should notify, notify it now, and give it the internal byte array, so that
|
|
* it doesn't have to ask the CPU for the data. Currently, the only component that uses this notification
|
|
* option is the Video component, and only when the associated ROM contains font data that it needs.
|
|
*/
|
|
if (this.idNotify) {
|
|
var component = Component.getComponentByID(this.idNotify, this.id);
|
|
if (component) {
|
|
component.onROMLoad(this.abROM);
|
|
}
|
|
}
|
|
/*
|
|
* We used to hang onto the original 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.
|
|
*/
|
|
delete this.abROM;
|
|
}
|
|
this.setReady();
|
|
}
|
|
}
|
|
};
|
|
|
|
/**
|
|
* addROM(addr)
|
|
*
|
|
* If addr is null or undefined, then it's presumably an unused addrROMAlias, which we simply ignore (it's not
|
|
* considered a failure condition).
|
|
*
|
|
* @this {ROM}
|
|
* @param {number} addr
|
|
* @return {boolean}
|
|
*/
|
|
ROM.prototype.addROM = function(addr)
|
|
{
|
|
if (addr == null) return true;
|
|
if (this.bus.addMemory(addr, this.sizeROM, true)) {
|
|
if (DEBUG) this.log("addROM(): copying ROM to " + str.toHexAddr(addr) + " (0x" + str.toHex(this.abROM.length) + " bytes)");
|
|
for (var i = 0; i < this.abROM.length; i++) {
|
|
this.bus.setByteDirect(addr + i, this.abROM[i]);
|
|
}
|
|
return true;
|
|
}
|
|
/*
|
|
* We don't need to report an error here, because addMemory() already takes care of that.
|
|
*/
|
|
return false;
|
|
};
|
|
|
|
/**
|
|
* ROM.init()
|
|
*
|
|
* This function operates on every element (e) of class "rom", and initializes
|
|
* all the necessary HTML to construct the ROM module(s) as spec'ed.
|
|
*
|
|
* Note that each element (e) of class "rom" is expected to have a "data-value"
|
|
* attribute containing the same JSON-encoded parameters that the ROM constructor
|
|
* expects.
|
|
*/
|
|
ROM.init = function()
|
|
{
|
|
var aeROM = Component.getElementsByClass(window.document, PCJSCLASS, "rom");
|
|
for (var iROM = 0; iROM < aeROM.length; iROM++) {
|
|
var eROM = aeROM[iROM];
|
|
var parmsROM = Component.getComponentParms(eROM);
|
|
var rom = new ROM(parmsROM);
|
|
Component.bindComponentControls(rom, eROM, PCJSCLASS);
|
|
}
|
|
};
|
|
|
|
/*
|
|
* Initialize all the ROM modules on the page.
|
|
*/
|
|
web.onInit(ROM.init);
|
|
|
|
if (typeof APP_PCJS !== 'undefined') APP_PCJS.ROM = ROM;
|
|
|
|
if (typeof module !== 'undefined') module.exports = ROM;
|