forked from jeffpar/pcjs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathrom.js
678 lines (654 loc) · 31.6 KB
/
rom.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
/**
* @fileoverview Implements the PCx86 ROM component
* @author Jeff Parsons <[email protected]>
* @copyright © 2012-2024 Jeff Parsons
* @license MIT <https://www.pcjs.org/LICENSE.txt>
*
* This file is part of PCjs, a computer emulation software project at <https://www.pcjs.org>.
*/
import Memoryx86 from "./memory.js";
import MESSAGE from "./message.js";
import Component from "../../../modules/v2/component.js";
import DumpAPI from "../../../modules/v2/dumpapi.js";
import StrLib from "../../../modules/v2/strlib.js";
import WebLib from "../../../modules/v2/weblib.js";
import { APPCLASS, BACKTRACK, DEBUG, MAXDEBUG } from "./defines.js";
/**
* @class ROMx86
* @unrestricted (allows the class to define properties, both dot and named, outside of the constructor)
*
* 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().
*/
export default class ROMx86 extends Component {
/**
* ROM BIOS Data Area (RBDA) definitions, in physical address form, using the same CAPITALIZED names
* found in the original IBM PC ROM BIOS listing.
*/
static BIOS = {
RS232_BASE: 0x400, // ADDRESSES OF RS232 ADAPTERS (4 words)
PRINTER_BASE: 0x408, // ADDRESSES OF PRINTERS (4 words)
EQUIP_FLAG: { // INSTALLED HARDWARE (word)
ADDR: 0x410,
NUM_PRINT: 0xC000, // NUMBER OF PRINTERS ATTACHED
GAME_CTRL: 0x1000, // GAME I/O ATTACHED
NUM_RS232: 0x0E00, // NUMBER OF RS232 CARDS ATTACHED
NUM_DRIVES: 0x00C0, // NUMBER OF DISKETTE DRIVES (00=1, 01=2, 10=3, 11=4) ONLY IF IPL_DRIVE SET
VIDEO_MODE: 0x0030, // INITIAL VIDEO MODE (00=UNUSED, 01=40X25 COLOR, 10=80X25 COLOR, 11=80X25 MONO)
RAM_SIZE: 0x000C, // PLANAR RAM SIZE (00=16K,01=32K,10=48K,11=64K)
IPL_DRIVE: 0x0001 // IPL (Initial Program Load) FROM DISKETTE (ie, diskette drives exist)
},
MFG_TEST: 0x412, // INITIALIZATION FLAG (byte)
MEMORY_SIZE: 0x413, // MEMORY SIZE IN K BYTES (word)
IO_RAM_SIZE: 0x415, // PC: MEMORY IN I/O CHANNEL (word)
MFG_ERR_FLAG: 0x415, // PC AT: SCRATCHPAD FOR MANUFACTURING ERROR CODES (2 bytes)
COMPAQ_PREV_SC: 0x415, // COMPAQ DESKPRO 386: PREVIOUS SCAN CODE (byte)
COMPAQ_KEYCLICK:0x416, // COMPAQ DESKPRO 386: KEYCLICK LOUDNESS (byte)
/**
* KEYBOARD DATA AREAS
*/
KB_FLAG: { // FIRST BYTE OF KEYBOARD STATUS (byte)
ADDR: 0x417, //
INS_STATE: 0x80, // INSERT STATE IS ACTIVE
CAPS_STATE: 0x40, // CAPS LOCK STATE HAS BEEN TOGGLED
NUM_STATE: 0x20, // NUM LOCK STATE HAS BEEN TOGGLED
SCROLL_STATE: 0x10, // SCROLL LOCK STATE HAS BEEN TOGGLED
ALT_SHIFT: 0x08, // ALTERNATE SHIFT KEY DEPRESSED
CTL_SHIFT: 0x04, // CONTROL SHIFT KEY DEPRESSED
LEFT_SHIFT: 0x02, // LEFT SHIFT KEY DEPRESSED
RIGHT_SHIFT: 0x01 // RIGHT SHIFT KEY DEPRESSED
},
KB_FLAG_1: { // SECOND BYTE OF KEYBOARD STATUS (byte)
ADDR: 0x418, //
INS_SHIFT: 0x80, // INSERT KEY IS DEPRESSED
CAPS_SHIFT: 0x40, // CAPS LOCK KEY IS DEPRESSED
NUM_SHIFT: 0x20, // NUM LOCK KEY IS DEPRESSED
SCROLL_SHIFT: 0x10, // SCROLL LOCK KEY IS DEPRESSED
HOLD_STATE: 0x08 // SUSPEND KEY HAS BEEN TOGGLED
},
ALT_INPUT: 0x419, // STORAGE FOR ALTERNATE KEYPAD ENTRY (byte)
BUFFER_HEAD: 0x41A, // POINTER TO HEAD OF KEYBOARD BUFFER (word)
BUFFER_TAIL: 0x41C, // POINTER TO TAIL OF KEYBOARD BUFFER (word)
KB_BUFFER: 0x41E, // ROOM FOR 15 ENTRIES (16 words)
KB_BUFFER_END: 0x43E, // HEAD = TAIL INDICATES THAT THE BUFFER IS EMPTY
/**
* DISKETTE DATA AREAS
*/
SEEK_STATUS: { // DRIVE RECALIBRATION STATUS (byte)
ADDR: 0x43E, //
// BIT 3-0 = DRIVE 3-0 NEEDS RECAL BEFORE
// NEXT SEEK IF BIT IS = 0
INT_FLAG: 0x80, // INTERRUPT OCCURRENCE FLAG
},
MOTOR_STATUS: 0x43F, // MOTOR STATUS (byte)
// BIT 3-0 = DRIVE 3-0 IS CURRENTLY RUNNING
// BIT 7 = CURRENT OPERATION IS A WRITE, REQUIRES DELAY
MOTOR_COUNT: 0x440, // TIME OUT COUNTER FOR DRIVE TURN OFF
// 37 == TWO SECONDS OF COUNTS FOR MOTOR TURN OFF
DISKETTE_STATUS: { // SINGLE BYTE OF RETURN CODE INFO FOR STATUS
ADDR: 0x441,
TIME_OUT: 0x80, // ATTACHMENT FAILED TO RESPOND
BAD_SEEK: 0x40, // SEEK OPERATION FAILED
BAD_NEC: 0x20, // NEC CONTROLLER HAS FAILED
BAD_CRC: 0x10, // BAD CRC ON DISKETTE READ
DMA_BOUNDARY: 0x09, // ATTEMPT TO DMA ACROSS 64K BOUNDARY
BAD_DMA: 0x08, // DMA OVERRUN ON OPERATION
RECORD_NOT_FND: 0x04, // REQUESTED SECTOR NOT FOUND
WRITE_PROTECT: 0x03, // WRITE ATTEMPTED ON WRITE PROT DISK
BAD_ADDR_MARK: 0x02, // ADDRESS MARK NOT FOUND
BAD_CMD: 0x01 // BAD COMMAND PASSED TO DISKETTE I/O
},
NEC_STATUS: 0x442, // STATUS BYTES FROM NEC (7 bytes)
/**
* VIDEO DISPLAY DATA AREA
*/
CRT_MODE: 0x449, // CURRENT CRT MODE (byte)
CRT_COLS: 0x44A, // NUMBER OF COLUMNS ON SCREEN (word)
CRT_LEN: 0x44C, // LENGTH OF REGEN IN BYTES (word)
CRT_START: 0x44E, // STARTING ADDRESS IN REGEN BUFFER (word)
CURSOR_POSN: 0x450, // CURSOR FOR EACH OF UP TO 8 PAGES (8 words)
CURSOR_MODE: 0x460, // CURRENT CURSOR MODE SETTING (word)
ACTIVE_PAGE: 0x462, // CURRENT PAGE BEING DISPLAYED (byte)
ADDR_6845: 0x463, // BASE ADDRESS FOR ACTIVE DISPLAY CARD (word)
CRT_MODE_SET: 0x465, // CURRENT SETTING OF THE 3X8 REGISTER (byte)
CRT_PALLETTE: 0x466, // CURRENT PALLETTE SETTING COLOR CARD (byte)
/**
* CASSETTE DATA AREA
*/
EDGE_CNT: 0x467, // PC: TIME COUNT AT DATA EDGE (word)
CRC_REG: 0x469, // PC: CRC REGISTER (word)
LAST_VAL: 0x46B, // PC: LAST INPUT VALUE (byte)
IO_ROM_INIT: 0x467, // PC AT: POINTER TO ROM INITIALIZATION ROUTINE
IO_ROM_SEG: 0x469, // PC AT: POINTER TO I/O ROM SEGMENT
INTR_FLAG: 0x46B, // PC AT: FLAG INDICATING AN INTERRUPT HAPPENED
/**
* TIMER DATA AREA
*/
TIMER_LOW: 0x46C, // LOW WORD OF TIMER COUNT (word)
TIMER_HIGH: 0x46E, // HIGH WORD OF TIMER COUNT (word)
TIMER_OFL: 0x470, // TIMER HAS ROLLED OVER SINCE LAST READ (byte)
/**
* SYSTEM DATA AREA
*/
BIOS_BREAK: 0x471, // BIT 7 = 1 IF BREAK KEY HAS BEEN DEPRESSED (byte)
/**
* RESET_FLAG is the traditional end of the RBDA, as originally defined by the IBM PC
*/
RESET_FLAG: {
ADDR: 0x472, // SET TO 0x1234 IF KEYBOARD RESET UNDERWAY (word)
WARMBOOT: 0x1234 // this value indicates a "warm boot", bypassing memory tests
},
/**
* FIXED DISK DATA AREAS
*/
DISK_STATUS1: 0x474, // PC AT: FIXED DISK STATUS (byte)
HF_NUM: 0x475, // PC AT: COUNT OF FIXED DISK DRIVES (byte)
CONTROL_BYTE: 0x476, // PC AT: HEAD CONTROL BYTE (byte)
PORT_OFF: 0x477, // PC AT: RESERVED (PORT OFFSET) (byte)
/**
* TIME-OUT VARIABLES
*/
PRINT_TIM_OUT: 0x478, // PC AT: TIME OUT COUNTERS FOR PRINTER RESPONSE (4 bytes)
RS232_TIM_OUT: 0x47C, // PC AT: TIME OUT COUNTERS FOR RS232 RESPONSE (4 bytes)
/**
* ADDITIONAL KEYBOARD DATA AREA
*/
BUFFER_START: 0x480, // PC AT: OFFSET OF KEYBOARD BUFFER START WITHIN SEGMENT 40H
BUFFER_END: 0x482, // PC AT: OFFSET OF END OF BUFFER
/**
* EGA/PGA DISPLAY WORK AREA
*/
ROWS: 0x484, // PC AT: ROWS ON THE ACTIVE SCREEN (LESS 1) (byte)
POINTS: 0x485, // PC AT: BYTES PER CHARACTER (word)
INFO: 0x487, // PC AT: MODE OPTIONS (byte)
/**
* INFO BITS:
*
* 0x80: HIGH BIT OF MODE SET, CLEAR/NOT CLEAR REGEN
* 0x60: 256K OF VRAM
* 0x40: 192K OF VRAM
* 0x20: 128K OF VRAM
* 0x10: RESERVED
* 0x08: EGA ACTIVE MONITOR (0), EGA NOT ACTIVE (1)
* 0x04: WAIT FOR DISPLAY ENABLE (1)
* 0x02: EGA HAS A MONOCHROME ATTACHED
* 0x01: SET C_TYPE EMULATE ACTIVE (0)
*/
INFO_3: 0x488, // PC AT: FEATURE BIT SWITCHES (1 byte, plus 2 reserved bytes)
/**
* 40:88 byte PCjr: third keyboard status byte
* EGA feature bit switches, emulated on VGA
*
* |7|6|5|4|3|2|1|0| EGA feature bit switches (EGA+)
* | | | | | | | `-- EGA SW1 config (1=off)
* | | | | | | `--- EGA SW2 config (1=off)
* | | | | | `---- EGA SW3 config (1=off)
* | | | | `----- EGA SW4 config (1=off)
* | | | `------ Input FEAT0 (ISR0 bit 5) after output on FCR0
* | | `------- Input FEAT0 (ISR0 bit 6) after output on FCR0
* | `-------- Input FEAT1 (ISR0 bit 5) after output on FCR1
* `--------- Input FEAT1 (ISR0 bit 6) after output on FCR1
*
* 40:89 byte Video display data area (MCGA and VGA)
*
* |7|6|5|4|3|2|1|0| Video display data area (MCGA and VGA)
* | | | | | | | `-- 1=VGA is active
* | | | | | | `--- 1=gray scale is enabled
* | | | | | `---- 1=using monochrome monitor
* | | | | `----- 1=default palette loading is disabled
* | | | `------ see table below
* | | `------- reserved
* | `-------- 1=display switching enabled
* `--------- alphanumeric scan lines (see table below)
*
* Bit7 Bit4 Scan Lines
* 0 0 350 line mode
* 0 1 400 line mode
* 1 0 200 line mode
* 1 1 reserved
*/
/**
* ADDITIONAL MEDIA DATA
*/
LASTRATE: 0x48B, // PC AT: LAST DISKETTE DATA RATE SELECTED (byte)
HF_STATUS: 0x48C, // PC AT: STATUS REGISTER (byte)
HF_ERROR: 0x48D, // PC AT: ERROR REGISTER (byte)
HF_INT_FLAG: 0x48E, // PC AT: FIXED DISK INTERRUPT FLAG (byte)
HF_CNTRL: 0x48F, // PC AT: COMBO FIXED DISK/DISKETTE CARD BIT 0=1 (byte)
DSK_STATE: 0x490, // PC AT: DRIVE 0/1 MEDIA/OPERATION STATES (4 bytes)
DSK_TRK: 0x494, // PC AT: DRIVE 0/1 PRESENT CYLINDER (2 bytes)
/**
* ADDITIONAL KEYBOARD FLAGS
*/
KB_FLAG_3: {
ADDR: 0x496, // PC AT: KEYBOARD MODE STATE AND TYPE FLAGS (byte)
LC_E1: 0b00000001, // LAST CODE WAS THE E1 HIDDEN CODE
LC_E0: 0b00000010, // LAST CODE WAS THE E0 HIDDEN CODE
R_CTL_SHIFT: 0b00000100, // RIGHT CTL KEY DOWN
R_ALT_SHIFT: 0b00001000, // RIGHT ALT KEY DOWN
GRAPH_ON: 0b00001000, // ALT GRAPHICS KEY DOWN (WT ONLY)
KBX: 0b00010000, // ENHANCED KEYBOARD INSTALLED
SET_NUM_LK: 0b00100000, // FORCE NUM LOCK IF READ ID AND KBX
LC_AB: 0b01000000, // LAST CHARACTER WAS FIRST ID CHARACTER
RD_ID: 0b10000000 // DOING A READ ID (MUST BE BIT0)
},
KB_FLAG_2: {
ADDR: 0x497, // PC AT: KEYBOARD LED FLAGS (byte)
KB_LEDS: 0b00000111, // KEYBOARD LED STATE BITS
SCROLL_LOCK: 0b00000001, // SCROLL LOCK INDICATOR
NUM_LOCK: 0b00000010, // NUM LOCK INDICATOR
CAPS_LOCK: 0b00000100, // CAPS LOCK INDICATOR
KB_FA: 0b00010000, // ACKNOWLEDGMENT RECEIVED
KB_FE: 0b00100000, // RESEND RECEIVED FLAG
KB_PR_LED: 0b01000000, // MODE INDICATOR UPDATE
KB_ERR: 0b10000000 // KEYBOARD TRANSMIT ERROR FLAG
},
/**
* REAL TIME CLOCK DATA AREA
*/
USER_FLAG: 0x498, // PC AT: OFFSET ADDRESS OF USERS WAIT FLAG (word)
USER_FLAG_SEG: 0x49A, // PC AT: SEGMENT ADDRESS OF USER WAIT FLAG (word)
RTC_LOW: 0x49C, // PC AT: LOW WORD OF USER WAIT FLAG (word)
RTC_HIGH: 0x49E, // PC AT: HIGH WORD OF USER WAIT FLAG (word)
RTC_WAIT_FLAG: 0x4A0, // PC AT: WAIT ACTIVE FLAG (01=BUSY, 80=POSTED, 00=POST ACKNOWLEDGED) (byte)
/**
* AREA FOR NETWORK ADAPTER
*/
NET: 0x4A1, // PC AT: RESERVED FOR NETWORK ADAPTERS (7 bytes)
/**
* EGA/PGA PALETTE POINTER
*/
SAVE_PTR: 0x4A8, // PC AT: POINTER TO EGA PARAMETER CONTROL BLOCK (2 words)
/**
* DATA AREA - PRINT SCREEN
*/
STATUS_BYTE: 0x500 // PRINT SCREEN STATUS BYTE (00=READY/OK, 01=BUSY, FF=ERROR) (byte)
};
/**
* ROMx86(parmsROM)
*
* The ROMx86 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 doneLoad()).
*
* Also, while the size parameter may seem redundant, I consider it useful to confirm that the ROM you received
* is the ROM you expected.
*
* @this {ROMx86}
* @param {Object} parmsROM
*/
constructor(parmsROM)
{
super("ROMx86", parmsROM, MESSAGE.MEM);
this.abROM = null;
this.addrROM = +parmsROM['addr']; // we allow numbers or strings (JSON strings permit hex)
this.sizeROM = +parmsROM['size']; // we allow numbers or strings (JSON strings permit hex)
/**
* 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") {
if (this.addrAlias[0] != '[') {
this.addrAlias = +this.addrAlias;
} else {
this.addrAlias = eval(this.addrAlias);
}
}
/**
* The 'notify' property can now (as of v1.18.2) contain an array of parameters that the notified
* component (typically Video) may use as it sees fit. For example, the Video component is generally
* interested in knowing the offsets of specific font tables within the ROM, which used to be hard-coded
* when all we supported were a few specific IBM video cards, but that's no longer feasible as we move
* beyond the original handful of IBM cards.
*
* It's up to the notified component to decide how to interpret the parameters it receives, if any.
*/
this.idNotify = parmsROM['notify'];
this.aNotifyParms = null;
if (this.idNotify) {
let i = this.idNotify.indexOf('[');
if (i > 0) {
try {
this.aNotifyParms = eval(this.idNotify.substr(i));
} catch (e) {}
this.idNotify = this.idNotify.substr(0, i);
}
}
this.sFileURL = this.sFilePath = parmsROM['file'];
if (this.sFileURL) {
let sFileName = StrLib.getBaseName(this.sFileURL);
if (DEBUG) this.printf(MESSAGE.LOG, "load(\"%s\")\n", this.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.
*/
let sFileExt = StrLib.getExtension(sFileName);
if (sFileExt != DumpAPI.FORMAT.JSON && sFileExt != DumpAPI.FORMAT.HEX) {
this.sFileURL = WebLib.getHostOrigin() + DumpAPI.ENDPOINT + '?' + DumpAPI.QUERY.FILE + '=' + this.sFilePath + '&' + DumpAPI.QUERY.FORMAT + '=' + DumpAPI.FORMAT.BYTES + '&' + DumpAPI.QUERY.DECIMAL + '=true';
}
}
}
/**
* initBus(cmp, bus, cpu, dbg)
*
* @this {ROMx86}
* @param {Computer} cmp
* @param {Busx86} bus
* @param {CPUx86} cpu
* @param {Debuggerx86} dbg
*/
initBus(cmp, bus, cpu, dbg)
{
this.cmp = cmp;
this.bus = bus;
this.cpu = cpu;
this.dbg = dbg;
if (this.sFileURL) {
let rom = this;
WebLib.getResource(this.sFileURL, null, true, function doneROMLoad(sURL, sResponse, nErrorCode) {
rom.doneLoad(sURL, sResponse, nErrorCode);
}, function(nState) {
rom.printf(MESSAGE.PROGRESS, "Loading %s...\n", rom.sFileURL);
});
}
}
/**
* powerUp(data, fRepower)
*
* @this {ROMx86}
* @param {Object|null} data
* @param {boolean} [fRepower]
* @returns {boolean} true if successful, false if failure
*/
powerUp(data, fRepower)
{
if (this.aSymbols) {
if (this.dbg) {
this.dbg.addSymbols(this.id, 0, this.addrROM >>> 4, 0, 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 {ROMx86}
* @param {boolean} [fSave]
* @param {boolean} [fShutdown]
* @returns {Object|boolean} component state if fSave; otherwise, true if successful, false if failure
*/
powerDown(fSave, fShutdown)
{
return true;
}
/**
* doneLoad(sURL, sROMData, nErrorCode)
*
* @this {ROMx86}
* @param {string} sURL
* @param {string} sROMData
* @param {number} nErrorCode (response from server if anything other than 200)
*/
doneLoad(sURL, sROMData, nErrorCode)
{
if (nErrorCode) {
this.printf(nErrorCode < 0? MESSAGE.STATUS : MESSAGE.NOTICE, "Unable to load system ROM (error %d: %s)\n", nErrorCode, sURL);
return;
}
Component.addMachineResource(this.idMachine, sURL, sROMData);
/**
* Check for JSON formats first.
*/
if (sROMData.charAt(0) == "[" || sROMData.charAt(0) == "{") {
try {
/**
* The most likely source of any exception will be here: parsing the JSON-encoded ROM data.
*/
let rom = eval("(" + sROMData + ")");
/**
* PCjs v2 ROM images contain, at a minimum, a 'width' value and a 'values' array, along with
* other optional properties, like default load address ('addr'), endianness ('littleEndian'), etc.
*
* So we'll start with that and fall back to 8-bit 'bytes' or 32-bit 'longs' (or worst-case, 'data',
* but the length of 'data' values varied according to the machine architecture, so the introduction
* of 'data' was a "bit" ill-advised).
*/
let width = rom['width'];
let values = rom['values'];
let littleEndian = (rom['littleEndian'] !== false);
if (!width || !values) {
width = 0;
if ((values = rom['bytes'])) {
width = 8;
}
else if ((values = rom['longs'] || rom['data'])) {
width = 32;
}
}
/**
* Convert all values to bytes, so that subsequent code has a simple and consistent data format: abROM.
*/
if (width) {
if (width == 8) {
this.abROM = values;
} else {
let bpv = width >>> 3;
this.abROM = new Array(values.length * bpv);
for (let i = 0, ib = 0; i < values.length; i++) {
let v = values[i];
if (littleEndian) {
for (let b = 0; b < bpv; b++) {
this.abROM[ib + b] = v & 0xff;
v >>>= 8;
}
} else {
for (let b = bpv - 1; b >= 0; b--) {
this.abROM[ib + b] = v & 0xff;
v >>>= 8;
}
}
ib += bpv;
}
}
}
else {
this.abROM = rom;
}
this.aSymbols = rom['symbols'];
if (!this.abROM.length) {
Component.error("Empty ROM: " + sURL);
return;
}
else if (this.abROM.length == 1) {
Component.error(this.abROM[0]);
return;
}
} catch (e) {
this.printf(MESSAGE.NOTICE, "ROM data error: %s\n", 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).
*/
let sHexData = sROMData.replace(/\n/gm, " ").replace(/ +$/, "");
let asHexData = sHexData.split(" ");
this.abROM = new Array(asHexData.length);
for (let i = 0; i < asHexData.length; i++) {
this.abROM[i] = StrLib.parseInt(asHexData[i], 16);
}
}
this.copyROM();
}
/**
* copyROM()
*
* This function is called by both initBus() and doneLoad(), but it cannot copy the the ROM data into place
* until after initBus() has received the Bus component AND doneLoad() has received the abROM data. When both
* those criteria are satisfied, the component becomes "ready".
*
* @this {ROMx86}
*/
copyROM()
{
if (!this.isReady()) {
if (!this.sFilePath) {
this.setReady();
}
else if (this.abROM && this.bus) {
/**
* If no explicit size was specified, then use whatever the actual size is.
*/
if (!this.sizeROM) {
this.sizeROM = this.abROM.length;
}
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. 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 (" + StrLib.toHexLong(this.abROM.length) + ") does not match specified size (" + StrLib.toHexLong(this.sizeROM) + ")");
}
else if (this.addROM(this.addrROM)) {
let aliases = [];
if (typeof this.addrAlias == "number") {
aliases.push(this.addrAlias);
} else if (this.addrAlias != null && this.addrAlias.length) {
aliases = this.addrAlias;
}
for (let i = 0; i < aliases.length; i++) {
this.cloneROM(aliases[i]);
}
/**
* 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) {
let component = Component.getComponentByID(this.idNotify, this.id);
if (component) {
component.onROMLoad(this.abROM, this.aNotifyParms);
} else {
this.printf(MESSAGE.NOTICE, "Unable to find component: %s\n", this.idNotify);
}
}
/**
* 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)
*
* @this {ROMx86}
* @param {number} addr
* @returns {boolean}
*/
addROM(addr)
{
if (this.bus.addMemory(addr, this.sizeROM, Memoryx86.TYPE.ROM)) {
if (MAXDEBUG) this.printf(MESSAGE.LOG, "addROM(%#010x): copying %#06x bytes\n", addr, this.abROM.length);
let bto = null;
for (let off = 0; off < this.abROM.length; off++) {
this.bus.setByteDirect(addr + off, this.abROM[off]);
if (BACKTRACK) {
bto = this.bus.addBackTrackObject(this, bto, off);
this.bus.writeBackTrackObject(addr + off, bto, off);
}
}
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 {ROMx86}
* @param {number} addr
*/
cloneROM(addr)
{
let aBlocks = this.bus.getMemoryBlocks(this.addrROM, this.sizeROM);
this.bus.setMemoryBlocks(addr, this.sizeROM, aBlocks);
}
/**
* ROMx86.init()
*
* This function operates on every HTML element of class "rom", extracting the
* JSON-encoded parameters for the ROM constructor from the element's "data-value"
* attribute, invoking the constructor to create a ROM component, and then binding
* any associated HTML controls to the new component.
*/
static init()
{
let aeROM = Component.getElementsByClass(APPCLASS, "rom");
for (let iROM = 0; iROM < aeROM.length; iROM++) {
let eROM = aeROM[iROM];
let parmsROM = Component.getComponentParms(eROM);
let rom = new ROMx86(parmsROM);
Component.bindComponentControls(rom, eROM, APPCLASS);
}
}
}
/**
* Initialize all the ROM modules on the page.
*/
WebLib.onInit(ROMx86.init);