home *** CD-ROM | disk | FTP | other *** search
/ CD-X 1 / cdx_01.iso / shareuti / spectrum / z80.doc < prev    next >
Encoding:
Text File  |  1993-04-15  |  130.7 KB  |  2,565 lines

  1. Sinclair ZX Spectrum Emulator 'Z80' v2.0  -  16/4/93  -  by G.A. Lunter
  2.  
  3.  
  4.  
  5. Contents:
  6.  
  7.     1.    INTRODUCTION, REGISTRATION, GENERAL INFORMATION
  8.     1.1   Some general remarks...
  9.     1.2   Registering - sounds interesting!
  10.     1.3   Other emulators
  11.  
  12.     2.    THE EMULATOR
  13.     2.1   Starting the emulator
  14.     2.2   Using the emulator
  15.     2.3   Emulation of the Keyboard, Screen and Beeper
  16.     2.4   Using the Tape
  17.     2.5   Using the Microdrive
  18.     2.6   Using the RS232 channel
  19.     2.7   Joysticks
  20.     2.8   Transferring programs
  21.     2.9   Converting file formats - the utility CONVERT
  22.     2.10  The utilities Z802TAP and TAP2TAPE
  23.  
  24.     3.    THE SAMRAM
  25.     3.1   Basic extensions
  26.     3.2   NMI software
  27.     3.3   The built-in monitor
  28.  
  29.     4.    THE SPECTRUM
  30.     4.1   The Spectrum
  31.     4.2   The Interface I
  32.     4.3   The Spectrum 128
  33.  
  34.     5.    TECHNICAL INFORMATION
  35.     5.1   The Spectrum
  36.     5.2   The Interface I
  37.     5.3   The SamRam
  38.     5.4   The Z80 microprocessor
  39.     5.5   File formats
  40.  
  41.  
  42.  
  43.  
  44. 1. INTRODUCTION, REGISTRATION, GENERAL INFORMATION
  45.  
  46.  
  47. 1.1 Some general remarks...
  48.  
  49.     This is the documentation for 'Z80', a Sinclair ZX Spectrum 48/128
  50.     emulator.  This program turns your PC into a Spectrum.  To make you
  51.     read on...
  52.  
  53.       The program emulates a Spectrum 48K model 2 or 3 or Spectrum 128K,
  54.       is highly compatible with the real machines, includes the
  55.       Interface I, supports Microdrives, tape files, the RS232 channel,
  56.       '128 sound through internal speaker or Adlib compatible soundcard,
  57.       able to save and load every Spectrum program directly to and from
  58.       tape, even able to load speed-saved programs, supporting digital
  59.       and analogue PC joysticks and four common Spectrum joysticks, Z80
  60.       processor emulation including the R register, inofficial opcodes
  61.       and flags, accurate timing of individual instructions, control
  62.       over the emulated Spectrum's speed, and all that while requiring
  63.       only a PC-XT with 512K with CGA, Hercules, EGA or VGA; offering
  64.       conversion programs to convert between various emulators' Snapshot
  65.       formats and to read from Disciple and Plus D diskettes, to create
  66.       .PCX and .GIF files of Spectrum screen dumps, an English manual...
  67.       and more!
  68.  
  69.     Okay, that's enough.  Let me start.
  70.  
  71.     There is much to tell and explain in this documentation.  First of all
  72.     the emulator itself must run, and uses your PC's resources.  It is not
  73.     really a demanding program, but there are some things that need
  74.     attention.  These technicalities are dealt with in section 2.1.
  75.  
  76.     Some general things about the emulator are explained in section 2.2. If
  77.     you read 2.1 and 2.2, you'll be able to do most of the things you
  78.     probably ever want to do.  But to exploit all of its possibilities (and
  79.     oh, it can do so much!), you will really have to read it all.
  80.  
  81.     The Spectrum has a number of ways to communicate with the outside world,
  82.     like the obvious keyboard and the screen, but also the microdrives, the
  83.     tape interface, the beeper, the sound chip of the Spectrum 128, the
  84.     Kempston joystick, and the RS232 channel of the Interface I and Spectrum
  85.     128.  All these channels can be used to communicate with PC channels in
  86.     some way; for instance the keyboard is connected to the PC keyboard
  87.     (sounds obvious) and the tape I/O can be routed to a file, as well as to
  88.     a physical tape recorder.  All these things are explained in the rest of
  89.     chapter 2.  Paragraph 8 of that chapter contains a number of suggestions
  90.     how to transfer Spectrum programs to the PC.
  91.  
  92.     For our own Spectrums Johan Muizelaar and I built a piece of hardware we
  93.     called the SamRam (which has nothing to do with the SAM coupe, by the
  94.     way!).  It contains a monitor program and software to make snapshots of
  95.     programs.  It's still very useful and I still use it a lot, although the
  96.     physical SamRam doesn't work anymore.  An explanation of its functions
  97.     is to be found in chapter 3.
  98.  
  99.     Some things peculiar to the Spectrum, not specific to this program but
  100.     useful to know are collected in chapter 4.  It contains for instance a
  101.     table of Spectrum keywords and the key combination to get it;
  102.     unfortunately this information is not printed on standard PC keyboards!
  103.  
  104.     There are some interesting, rather unknown technical facts about the
  105.     Spectrum that I discovered while debugging the emulator.  As much as I
  106.     could think of is contained in the final chapter.  You don't need to
  107.     read this chapter to use the emulator; if you don't find it interesting
  108.     then skip it, but I think programmers will like it.
  109.  
  110.     A remark about copyrights.  There is some confusion about the copyright
  111.     on the Spectrum roms.  Because I intended to include the Spectrum 128
  112.     roms with the version 2.0 emulator program, I asked Amstrad whether they
  113.     would allow me to distribute the Spectrum roms.  Because they're not
  114.     selling Spectrums anymore, they don't mind the code being distributed.
  115.     Thanks, Amstrad!
  116.  
  117.     Then another remark about copyrights.  The source files are not public
  118.     domain, and you may not use them in other PC-based Spectrum emulators.
  119.     Also, the information in this documentation file, especially the info in
  120.     the final chapter (except for the file-format info in the final section)
  121.     may not be used for that purpose.  But you're free to use the info for
  122.     Spectrum emulators for other machines, provided that whenever you do so
  123.     you should name the source.
  124.  
  125.     For Spectrum software, utilities, other emulators for PC's as well as
  126.     other computers, and other Spectrum related software, you can call the
  127.     Spectrum Emulator support BBS in Groningen:
  128.  
  129.         Tatort BBS Groningen
  130.         050-264840
  131.         (+31-50-264840)
  132.         v22, v22bis, v32, v32bis, MNP2-5, v42, v42bis (300-14400 baud)
  133.  
  134.     At the time of writing the BBS is open 24 hours a day, but this is
  135.     subject to change.  Please try calling between 22:00 and 9:00 local time
  136.     first.
  137.  
  138.     If you have access to Internet, you can find several Spectrum emulators
  139.     in a directory of for instance wuarchive.wustl.edu (take a look in
  140.     /systems/sinclair and -/msdos/emulators) or nic.funet.fi.  And if you
  141.     want to get in touch with me, my email address is gerton@rcondw.rug.nl.
  142.  
  143.  
  144.  
  145.  
  146.  
  147. 1.2  Registering - sounds interesting!
  148.  
  149.     First of all, this program is shareware.  That means that you're
  150.     encouraged to give it away to others, but if you do be sure not to alter
  151.     the files.  Also please don't add things to the archive file. Shareware
  152.     means that you may try the program some time; if you like it you should
  153.     register for it.
  154.  
  155.     The shareware version of the emulator consists of the following files:
  156.  
  157.  
  158.         Z80.EXE      - The emulator
  159.         Z80.DOC      - This documentation file
  160.         Z80.INI      - Default initialisation file
  161.         Z80.PIF      - Program Info File to run 'Z80' under Windows 3.1
  162.         ROMS.BIN     - Various ROM images
  163.         LAYOUT.SCR   - Keyboard lay-out help screen
  164.         GETRS.COM    - Utility to receive blocks through RS232 lead
  165.         SAVESPEC.Z80 - Utility to send .Z80 files from Spectrum to PC
  166.         DIAGRAM.Z80  - Circuit diagram for tape interface, and calibration
  167.         Z80FAQ.DOC   - Frequently asked questions - and answers!
  168.         NEW.DOC      - The What's New file
  169.  
  170.  
  171.     The shareware version of the emulator program is not fully functional.
  172.     It cannot be slowed down, and it can't load programs from tape.  All
  173.     other functions work the same in both versions.  If you register, you
  174.     will receive the fully functional emulator together with the following
  175.     utilities:
  176.  
  177.         CONVERT  - a general conversion program: can list out BASIC and
  178.                    tranlate it back, produce .GIF or .PCX files from
  179.                    screendumps, translate Spectrum ASCII (CR) to PC ASCII
  180.                    (CR/LF), and some other things.
  181.         CONVZ80  - Translates various snapshot and tape formats of other
  182.                    Spectrum emulators into each other.  Can handle Arnt
  183.                    Gulbrandsen's (JPP) .SNA format, Pedro Gimeno's
  184.                    (VGASPEC and SPECTRUM) .SP format and Kevin J. Phairs'
  185.                    (SPECEM) .PRG format.  It can also handle tape files
  186.                    of SPECEM and L. Rindt and E. Brukner's emulator ZX.
  187.         DISCIPLE - Reads DISCiPLE and Plus D diskettes, both 3.5'' and
  188.                    5.25''.  It translates the 48K and 128K snapshot files
  189.                    to .Z80 snapshots, and ordinary files and screen
  190.                    snapshots to .TAP tape files.
  191.         Z802TAP  - Converts a .Z80 snapshot, 48K or 128K, to a .TAP file
  192.                    which can be loaded into the emulator and saved to tape
  193.                    by the next utility:
  194.         TAP2TAPE - Saves the contents of a .TAP file back to tape, to
  195.                    load it into an ordinary Spectrum.
  196.         Z80DUMP  - Shows the contents of the header of a .Z80 file.
  197.  
  198.  
  199.     You will also receive the source files of the emulator, the above
  200.     utilities and the SamRam, and you'll be kept informed about future
  201.     updates.
  202.  
  203.     The registration fee is 20 US$, or 15 British pounds, or 35 German
  204.     Marks, or 35 Dutch guilders, or some of your local (hard) currency of
  205.     about that amount.  Now there are several way to get the money to me. In
  206.     order of preference:
  207.  
  208.         1.  Simply send banknotes.
  209.         2.  From Europe, send a Eurocheque of HFL 35,--
  210.         3.  Send a postal money-order (Works fine from e.g. Italy and
  211.             Spain)
  212.         4.  Send a bank cheque.  Please add the equivalent of 20 Dutch
  213.             guilders, for that's the amount the banks charge for drawing
  214.             foreign cheques.
  215.  
  216.     If you're sending a Eurocheque, make sure you fill it in completely
  217.     (don't forget the number at the back!) and fill in 'Groningen' for the
  218.     place.  If you don't send Dutch currency, or don't fill it in
  219.     completely, or fill in a foreign city, the banks charge me fifteen to
  220.     twenty guilders to cash the cheque.
  221.  
  222.     For Dutch users, the fee is HFL 25,--.  In Nederland gaat het betalen
  223.     het gemakkelijkst via de giro.  Maak het bedrag over op giro 59.45.263
  224.     t.n.v. G.A. Lunter, Groningen.  Zorg er wel voor dat uw naam en adres
  225.     vermeld staan! (vooral als u Girotel gebruikt)
  226.  
  227.     Send the money, together with your name and address to:
  228.  
  229.                 Gerton Lunter
  230.                 P.O. Box 2535
  231.                 NL-9704 CM  Groningen
  232.                 The Netherlands
  233.  
  234.     You'll get the files on a 3.5'' DD disk by default, but you can also get
  235.     in on 5.25 inch disks if you want.
  236.  
  237.     Registrations can also be handled by B G Services in the UK if this is
  238.     more convenient.  The cost is the same (15 British pounds).  Payment can
  239.     be by cheque or postal order made payable to B G Services.  The address
  240.     is:
  241.  
  242.                 B G Services
  243.                 64 Roebuck Road
  244.                 Chessington
  245.                 Surrey KT9 1JX
  246.  
  247.     Telephone enquiries on 081 397 0763, Fax 081 391 0744.
  248.  
  249.  
  250.  
  251.  
  252. 1.3  Other emulators
  253.  
  254.     There are several other Spectrum emulators, both for the PC and other
  255.     computers.  The list below is partly due to Carlo Delhez (the QL
  256.     emulators) and partly copied from Arnt Gulbrandsen's documentation of
  257.     his JPP.  I don't think the list is complete, so if you know more
  258.     Spectrum emulators, for any computer, please let me know.
  259.  
  260.  
  261.     For the PC:
  262.  
  263.     o JPP, by Arnt Gulbrandsen (Norway).  Faster than mine (but according
  264.       to an OUTLET review slower on some boards), by using a very smart
  265.       decoding technique, but requires a 80386 or '486 processor.  Is less
  266.       compatible than Z80.  Uses the .SNA snapshot format.  Needs VGA.
  267.       Not many extra features.
  268.     o VGASPEC, by Alberto Olloqui (Spain).  Needs VGA and 80286.  Quite
  269.       slow, and crashes on quite a lot of programs.  Uses the .SP snapshot
  270.       format.  Allows ROM pokes.  This program is an illegal pre-release
  271.       of SPECTRUM, by Pedro Gimeno.
  272.     o SPECTRUM, by Pedro Gimeno (Spain).  Uses another .SP snapshot
  273.       format.  Has a tape interface.  Also quite slow.  Allows changing
  274.       the rom.
  275.     o SP, by J. Swiatek and K. Makowski (Poland).  Cannot load or save
  276.       snapshots, but can load programs using LOAD "" via a file called
  277.       TAPE_ZX.SPC.  Crashes many programs; even basic behaves weird
  278.       sometimes.  Has a built-in monitor, but no documentation.  No
  279.       border.
  280.     o SPECEM, by Kevin J. Phair (Ireland).  Also allows rom changes.
  281.       Displays the registers on screen.  Can save and load directly
  282.       from disk using LOAD/SAVE "filename" in BASIC.  Loads .PRG
  283.       snapshots, but cannot save them.  Emulates a Multiface I.
  284.     o ZX, by L. Rindt and E. Brukner (Czech Republic).  Haven't tested
  285.       its compatibility thoroughly, but one of the games supplied didn't
  286.       respond well to the keyboard, while it did work on Z80 after
  287.       conversion.  Good tape file support including headerless files,
  288.       almost identical to the multiple .TAP file mode of Z80.  Somewhat
  289.       slower than Z80.  Includes program to load from tape and convert
  290.       to tape file.  No documentation at all.
  291.  
  292.  
  293.     For the Sinclair QL:
  294.  
  295.     o SPECTATOR by Carlo Delhez (The Netherlands).  Shareware; supports
  296.       tape-files, Microdrives, RS232, Z80 snapshots, MBF snapshots and
  297.       Disciple (SNP) snapshots; multitasking; utilities to convert
  298.       Disciple, Beta and Opus disks enclosed.
  299.     o ZM-1/2/3 by Ergon Development (Italy).  ZM-1 is shareware, ZM-2/3
  300.       are commercial.  Supports only tape-files; contains a utility to
  301.       transfer programs from tape via a Spectrum to the QL.
  302.     o ZX by Andew Lavrov (CIS).  Shareware; supports tape-files, MBF
  303.       snapshots and Z80 snapshots; multitasking; utility to read from
  304.       Spectrum tapes (and write them).
  305.  
  306.     Spectator, ZM-1 and ZX all emulate at about the same speed (approx-
  307.     imately 30 to 40% on a 16 MHz MC68000 machine).  ZM-2/3 are said to be
  308.     faster (I [Carlo Delhez] have not seen them working yet), but this at
  309.     the cost of compatibility.  Finally, there is a ZX81 emulator called
  310.     XTricator, written by Carlo Delhez.
  311.  
  312.  
  313.     For the Amiga:
  314.  
  315.     o Spectrum, by Peter McGavin.  Very good, JPP is based to a large
  316.       extent on it.  Needs about a 25MHz machine to run at full speed.
  317.       Has tape support.
  318.     o KGB.  I haven't seen it.  A bit slower than Peter's, and the
  319.       version Peter saw wouldn't work on the Amiga 3000.
  320.     o An Italian emulator which I don't know the name of.  Excellent
  321.       compatibility, rather fast.  May be shareware.
  322.     o Several unreleased emulators.  Peter knows more about them.
  323.  
  324.  
  325.     For the Atari ST/TT:
  326.  
  327.     o One, called Spectrum.  Don't know anything about it, but the doc
  328.       file is written in quite the worst English I've seen.  [This is
  329.       Arnt speaking --- I've seen worse! GAL] Available by anonymous
  330.       ftp from terminator.cc.umich.edu.
  331.     o There's another one in the make, to be released very soon as one of
  332.       the programmers told me, written by Markus Oberhumer and other(s).
  333.  
  334.  
  335.     For the Acorn Archimedes:
  336.  
  337.     o A company called Arxe wrote one, intended to be commercial but
  338.       never released because Amstrad wouldn't permit Arxe to enclose the
  339.       ROM.  [But see remark at end of section 1.1 - GAL]
  340.     o Someone called D. Lawrence wrote another, or maybe the same.
  341.       This one is floating around but nobody has any documentation.  I
  342.       don't know what its status is.  Runs at about 70% of Spectrum speed on
  343.       an ARM2, not quite perfect graphics emulation.
  344.  
  345.  
  346.     For the Commodore 64:
  347.  
  348.     o The Whitby Software Spectrum simulator is a rewrite of the
  349.       Spectrum Basic.  It will not run machine-code programs.  I don't
  350.       know whether it's PD, shareware, or commercial.  Quite good.
  351.       (Responds nicely to a POKE 23659,0)
  352.  
  353.     All emulators for PC, and some for the Atari, Amiga and QL are available
  354.     on the support BBS: see paragraph 1.1 or the README.DOC.
  355.  
  356.     There are also emulators available for the ZX81.  Carlo Delhez, who also
  357.     wrote a Spectrum emulator for the QL, wrote the ZX81 emulators XTricator
  358.     (for the QL) and XTender (for PC's).  These programs can also be
  359.     downloaded from the support BBS.
  360.  
  361.  
  362.  
  363.  
  364. 2.  THE EMULATOR
  365.  
  366.  
  367. 2.1  Starting the emulator
  368.  
  369.     The emulator will work on any PC with at least 512K memory, with a VGA,
  370.     EGA, Hercules, CGA or Plantronics video adapter.  If available, it will
  371.     also use EMS memory, an Adlib compatible soundcard, and an analogue or
  372.     digital joystick.
  373.  
  374.     The emulator will first read in the switches that are given in the
  375.     Z80.INI file.  You can enter switches there in the same way you would on
  376.     the command line.  Lines starting with a % sign will be ignored.
  377.  
  378.     After any switches, you may specify a snapshot file on the command line.
  379.     This file will then be loaded and executed directly.  The extension .Z80
  380.     is not necessary.  The emulator will also read .SNA files (the snapshot
  381.     format of, amongst others, Arnt Gulbrandsen's JPP); you don't have to
  382.     convert them to .Z80 files (but you may want to to save disk space).
  383.  
  384.     The emulator tries to figure out what hardware is available, and uses
  385.     things as it finds it.  Most of the time this will work without you
  386.     having to tell it anything, but if you have to you can override the
  387.     defaults by putting switches on the command line.  Switches that you use
  388.     often can be put in the Z80.INI file.  If you give a switch a second
  389.     time, for instance if it is also in the Z80.INI file, it will disable it
  390.     again.
  391.  
  392.     If you are using Hercules, try starting the emulator with -xh on the
  393.     command line.  The emulator will use a non-standard Hercules mode to
  394.     display a full-screen Spectrum picture.  You may need to calibrate your
  395.     monitor to make the image steady.
  396.  
  397.     If you're using Plantronics, try -p and -q to see which gives the best
  398.     result.
  399.  
  400.     If you're using a Trident VGA with version 3 BIOS, you may see the
  401.     picture compressed at the top of the screen, while the bottom half
  402.     contains vertical white lines.  This is due to a bug in the Trident VGA
  403.     Bios.  Start the emulator with the switch -xv to get a full picture.
  404.  
  405.     If you haven't got EMS memory, the page swapping of the Spectrum 128
  406.     cannot be emulated exactly.  Most programs will work - although quite
  407.     slowly because page swapping will take much time without EMS - but some
  408.     may crash.  On 386 and 486 machines you can emulate EMS by software,
  409.     using EMM386 for instance.  Of all the EMS emulators I've tried (that's
  410.     three or four) QEMM was by far the fastest, but the EMM386 supplied with
  411.     the new DOS 6 seems to be about as fast.  A slow EMS emulator can
  412.     degrade the performance of the '128 emulation significantly!  Some
  413.     computers have hardware EMS capabilities, some '286 boards for instance.
  414.     Refer to your own documentation for details.
  415.  
  416.     And don't use hard disk based EMS emulators: the Spectrum emulator will
  417.     drive your hard disk nuts!
  418.  
  419.     There are a few Spectrum programs that have an odd stack pointer, and
  420.     run over the ram/rom boundary, for instance Deep Strike.  This crashed
  421.     version 1.45 of the emulator.  The bug has been removed in version 2: if
  422.     the emulator tries to read a word at FFFF, the processor generates an
  423.     INT 0D interrupt and the emulator will handle it correctly. However,
  424.     this won't work when an EMS emulator is installed that puts the 386 or
  425.     486 processor in virtual 8086 mode.  You can test all this by typing
  426.     CLEAR 65535:POKE 65535,0: RETURN in Basic, and the emulator will lock up
  427.     if it runs in virtual mode.  There is no simple solution to this
  428.     problem, but luckily it doesn't happen often.  If it does, the easiest
  429.     way to to solve it is to change the Spectrum program so that it uses an
  430.     even SP --- this is always possible, but not always easy!
  431.  
  432.     A very few programs (the only examples known to me are Fireman and
  433.     Thing) are quite sensitive to the relative actual execution speed of
  434.     emulated Z80 instructions, and crash if it isn't exactly right. If you
  435.     slow down the emulator, these program will run fine, because then
  436.     individual instructions are more carefully timed.
  437.  
  438.     The Spectrum 128 has a built-in sound chip.  If you have an Adlib
  439.     compatible soundcard installed, the Spectrum 128 sound will be played
  440.     through the Adlib card.  If you haven't, the loudest of the three sound
  441.     channels will be played through the internal PC speaker.  Sometimes the
  442.     effect is quite nice, sometimes it is horrible, but it's all I can do on
  443.     a standard PC.  If you don't want to have the Spectrum 128 sound played
  444.     through the internal speaker, use the switch -xi.  If you don't want the
  445.     Adlib card to be used (for instance to hear the sound through the
  446.     internal speaker) use -xa.
  447.  
  448.     If you're using the Pro-Audio Spectrum 16 sound card, do not install the
  449.     resident FM.EXE program; it causes problems with the emulator. Do make
  450.     sure that MVSOUND.SYS is installed in your CONFIG.SYS file, to make the
  451.     Pro-Audio Spectrum 16 Adlib compatible.
  452.  
  453.     The noise channels of the Spectrum 128 sound chip can work on different
  454.     frequencies, whereas the FM chips of the Adlib card cannot.  However, if
  455.     your Soundblaster is equipped with CMS chips, the noise frequency can be
  456.     programmed.  Specify -xc to use the CMS chips.  (These chips are not
  457.     available on Soundblaster Pro cards, and neither on most Soundblaster
  458.     clones).
  459.  
  460.     If you're living in Belgium or France, you are probably using an AZERTY
  461.     keyboard.  Specifying -xz on the command line will make all letter keys
  462.     and many punctuation keys work in the right way.
  463.  
  464.     If the emulator erroneously detects an analogue or digital joystick, use
  465.     the switch -kk.
  466.  
  467.     It may be annoying to have to press Num-Lock every time you use the
  468.     Spectrum 128 (because otherwise you'll have to use Shift with the cursor
  469.     keys to move the menu bar).  To make the emulator press shift by default
  470.     every time you use the PC cursor keys in '128 mode, use the switch -xs.
  471.     If you press Num-Lock now (in '128 mode), the shift-key won't be
  472.     pressed.  The 48K modes are not affected by this switch.
  473.  
  474.     The emulator can now also be run under Windows 3.1!  However, you cannot
  475.     use the tape interface, Real mode doesn't work anymore, and the keyboard
  476.     is not emulated as well as usual, because I have to scan it using BIOS
  477.     calls.  Be sure not to set the keyboard repeat rate too low; an initial
  478.     delay of 250 ms followed by 10 keys a second will do, but don't make it
  479.     slower.  Some key combinations may not work, such as ALT 4 for $.  So if
  480.     you want to use the emulator seriously then you shouldn't run it under
  481.     Windows, but it's nice to see three Spectrums run simultaneously...  If
  482.     you let the emulator run full-screen you may use EGA or VGA, if you want
  483.     to run it windowed you'll probably have to use CGA, because the virtual
  484.     video display driver of Windows cannot handle the VGA mode I use
  485.     (although it's only a standard text mode!).  You'll probably want other
  486.     default settings of some parameters (such as the video mode) if you run
  487.     the emulator under Windows; the emulator will always use the .INI file
  488.     in the directory of the Z80.EXE file so the other switches must be put
  489.     on the command line, in a .PIF file.  An example .PIF file (which runs
  490.     the emulator in windowed CGA mode) is supplied.
  491.  
  492.     Since the execution speed of a program running under Windows heavily
  493.     depends on other processes, the emulator doesn't try to measure how fast
  494.     it is running under Windows.  It says it runs at 100%, and you can slow
  495.     it down in the usual way, but the percentage is now relative to the
  496.     maximum speed, and has nothing to do with the actual execution speed.
  497.  
  498.     The emulator will automatically detect whether Windows is running, and
  499.     act appropriately.  To run the emulator in Windows compatibility mode in
  500.     a normal DOS environment, use -xw.
  501.  
  502.     When running the emulator under Desqview, use -e for EGA mode display.
  503.  
  504.     To run the emulator with a different rom than the standard one, you can
  505.     specify a rom image file on the command line.  Use the switch -xr file,
  506.     where 'file' is the name of the image file.  This file should be exactly
  507.     16384 bytes long.  It will of course not be used in Spectrum 128 or
  508.     SamRam mode.
  509.  
  510.     These are the most important switches that you have to specify when you
  511.     start the emulator.  Most of the other switches are used to select
  512.     default values for various things which can also be changed when the
  513.     emulator is started.  Some useful things to select are default
  514.     directories for .Z80, .TAP and .MDR files; these will be explained
  515.     below.
  516.  
  517.  
  518.  
  519. 2.2  Using the emulator
  520.  
  521.     When the emulator starts, you'll see the usual Spectrum copyright
  522.     message appear on screen.  Pressing F1 will pop up a small help screen
  523.     that explains the function of the function keys and various other
  524.     special keys.
  525.  
  526.     By pressing F10, you enter the main menu of the emulator.  Most of the
  527.     menu options can be chosen directly by pressing another function key.
  528.     The only exception is X, Extra functions, for which no function keys
  529.     were available anymore.  If you're somewhere deep in the menu structure
  530.     of the main menu, pressing ESC will get you one level higher most of the
  531.     time.  Pressing F10 will get you back to the main menu.
  532.  
  533.     The 'Select Hardware' menu option sits under function key F9.  There are
  534.     five configurations you can choose: a normal Spectrum 48K with or
  535.     without Interface I, a Spectrum 128K with or without Interface I, and a
  536.     Spectrum with Interface I and SamRam.  Switching to another mode will by
  537.     default reset the Spectrum.  If you don't want this to happen, press
  538.     CTRL-ENTER instead of ENTER when you've made your choice.  It cannot be
  539.     guaranteed however that the Spectrum won't crash or behave weirdly, for
  540.     obvious reasons.  Going from a Spectrum 128 to a normal Spectrum will
  541.     almost always crash it, except if you enter the SPECTRUM command before
  542.     switching.
  543.  
  544.     To use SamRam's monitor on a 128 program, switch the hardware from the
  545.     main menu, and generate an NMI (Extra functions - N) before returning to
  546.     the emulator.  This will often work, but you can't return to the program
  547.     without crashing it.
  548.  
  549.     On a real Spectrum 128, the menu bar of the startup screen is moved
  550.     using the cursor keys on the '128 keyboard.  These keys simultaneously
  551.     press a normal cursor key (5,6,7 or 8) and shift.  So you can shift the
  552.     menu bar with shift-6 and shift-7.  As is already said above, it is
  553.     possible to use the PC cursor keys for this; you have to select Cursor
  554.     joystick emulation (which is selected by default) and press Num-Lock
  555.     once to have the PC-cursor keys press the Spectrum Shift key too.  You
  556.     could also specify -xs on the command line (or put it in the Z80.INI
  557.     file) to make the PC cursor keys by default press shift for you in '128
  558.     mode.
  559.  
  560.     The Save and Load Program options (F2 and F3) will save the whole state
  561.     of the Spectrum and some of the emulators' settings to a .Z80 snapshot
  562.     file.  It will pack the data somewhat, so that the length of the file
  563.     varies.  The amount of memory saved depends on the current hardware
  564.     mode; 48K for normal Spectrum, 80K for SamRam, and 128K for Spectrum
  565.     128.  The settings that are saved are those that are program dependent,
  566.     for instance which joystick emulation is used, and more technical
  567.     settings like those of the R register, LDIR and Issue 2 emulation,
  568.     double interrupt frequency and video synchronisation.  These are
  569.     explained below.
  570.  
  571.     Loading a .Z80 file will cause several settings to be changed. Resetting
  572.     the Spectrum will not reset these settings to their default values!
  573.     Especially the joystick emulation setting change can be confusing, so
  574.     keep track of that.
  575.  
  576.     The Change Settings menu pops up if you press F4.  You can do many
  577.     things here, and I won't explain them all here.  The I and O options can
  578.     be used to redirect the RS232 output; see paragraph 2.6 for information
  579.     on this.  R - R register emulation, and L - LDIR emulation are seldom
  580.     needed.  For remarks on these options see chapter 5, and paragraph 2.8.
  581.  
  582.     2 - Issue 2 emulation will turn the emulated Spectrum in an Issue 2
  583.     Spectrum.  (This option also works, but is ridiculous, in Spectrum 128
  584.     mode).  Some very old programs (Spinads) will not respond to the
  585.     keyboard properly on Issue 3 Spectrums, and for these programs this
  586.     option was added.  Seldom needed.
  587.  
  588.     F - fast flash makes flashing go twice as fast.  Not very useful.
  589.  
  590.     S - sound enables you to turn off all sound, useful for late-night
  591.     playing.
  592.  
  593.     D - double interrupt frequency is useful for slow machines, as some
  594.     programs will run faster when this option is on.  If you're typing in a
  595.     BASIC program on a slow machine, always turn this on, since the
  596.     keyboard, which is polled by an interrupt routine, will respond much
  597.     better.  On the other hand, some programs will crash with this option
  598.     active.
  599.  
  600.     V - video synchronisation is used to remove the flickering of moving
  601.     characters in some programs.  You can choose between Normal, High and
  602.     Low.  Normal works well for almost all programs; Ghosts and Goblins and
  603.     Zynaps look much better when this is turned to High.  If you see
  604.     characters not moving smoothly or flicker, or a background not moving as
  605.     a whole, experiment a little bit with this setting, and re-save the
  606.     snapshot when you've found the best setting.  (For a slightly more
  607.     detailed discussion of this option see section 5.1)
  608.  
  609.     J - joystick emulation specifies which Spectrum joystick the PC cursor
  610.     keys (and analogue or digital joystick, if it is available) control. You
  611.     can choose from Cursor (default), Kempston, Interface 1 and 2.  As I
  612.     already said above, if Cursor joystick is chosen, the Num-Lock key
  613.     controls whether Shift is pressed too if the PC cursor keys are pressed.
  614.     (Since the shift and number keys are pressed exactly simultaneously, it
  615.     is possible that the Spectrum has already read the Shift key, but not
  616.     yet the others, when you press both keys down. Sometimes you will
  617.     therefore get the number 5,6,7 or 8 instead of a cursor movement.)
  618.  
  619.     Finally, C - Change speed lets you control the speed of the emulator. As
  620.     a side effect, slowing down the emulator makes the timing of the various
  621.     opcodes correspond more exactly to the actual timing on a real
  622.     processor.
  623.  
  624.     That concludes the discussion of the F4-'change settings' menu.  Let's
  625.     continue with the other function keys.
  626.  
  627.     F5 generates an NMI.  Only useful if in SamRam mode; otherwise it may
  628.     reset the Spectrum or (sometimes) crash a program.  ALT-F5 or CTRL-F5
  629.     resets the Spectrum.
  630.  
  631.     F6 turns on Real Mode.  Try this when the emulator is playing a tune and
  632.     sounds a little harsh.  This mode is needed when you want to load
  633.     speed-saved games from tape; see below for more information.
  634.  
  635.     F7 and F8 activate the tape- and microdrive-menus.  Again, see below for
  636.     more information.
  637.  
  638.     Resetting the Spectrum, or generating an NMI can be done from the main
  639.     menu too, in the X - Extra Functions menu.  This is useful if you want
  640.     to activate the NMI software of the SamRam for instance just after
  641.     loading a snapshot file, or just after you changed the hardware mode.
  642.     From this menu you can also shell to DOS, and save or load a screen
  643.     snapshot: a 6912 byte file with extension .SCR that contains a dump of
  644.     the screen information.  This enables you to very easily transfer
  645.     screens from one Spectrum program to another.  The .SCR files can be
  646.     converted to .GIF or .PCX files by the CONVERT program, available to
  647.     registered users.
  648.  
  649.     When you're typing BASIC-programs in 48K mode, you'll probably have to
  650.     look up some Spectrum keywords.  Further down in this documentation
  651.     there is an alphabetical list of all keywords and their key-combination.
  652.     For 'on-line' help, press ALT-F1 to see the Spectrum keyboard layout.
  653.  
  654.  
  655.  
  656. 2.3  Emulation of the Keyboard, Screen and Beeper
  657.  
  658.     The keyboard.  Letter keys are mapped to the Spectrum's letter keys. The
  659.     ALT and CTRL keys can both be used for Symbol Shift.  Then, there are a
  660.     lot of keys on the PC keyboard which don't exist on the Spectrum
  661.     keyboard.  Many of them are used, to make things easier:
  662.  
  663.     The function keys have several special functions.  See the previous
  664.     paragraph.
  665.  
  666.     CTRL-Break and CTRL-ALT-DEL quit the emulator.
  667.  
  668.     The punctuation keys - = ; ' , .  / and their shifts: _ + : " < > ? have
  669.     the effect of pressing Symbol Shift and the corresponding letter key, so
  670.     you can use these in the straightforward way.
  671.  
  672.     The ESC key presses Shift-1, EDIT, used as a sort of ESC key in many
  673.     Spectrum programs.  The Backspace key presses Shift-0, the Delete of the
  674.     Spectrum.  CapsLock presses Shift-2, Spectrum's capslock key.
  675.  
  676.     The PC-cursor keys and the numeric keypad keys 8,4,6 and 2 control the
  677.     Cursor, Interface 2 or Kempston joystick.  The TAB key, and 0,5 and
  678.     ./DEL on the numeric keypad control the fire button.  If the Cursor
  679.     joystick is selected, you can select whether Shift should also be
  680.     pressed with the NumLock key (but see the discussion above of the -xs
  681.     switch).
  682.  
  683.     If you're running the emulator on a slow computer, try selecting double
  684.     interrupt frequency.  Most programs poll the keyboard by interrupt, in
  685.     any case the ROM does, and doubling the frequency with which this
  686.     happens will make the emulated Spectrum react much more quickly on your
  687.     keystrokes.
  688.  
  689.     If you've got an AZERTY keyboard, the standard mappings of the keys
  690.     won't work at all properly.  Include the switch -xz in your Z80.INI file
  691.     in this case; many punctuation keys will now also work properly. There
  692.     is no support for other non-US keyboard layouts; sorry!
  693.  
  694.  
  695.     Now about the screen emulation.  Fifty times an (emulated) second, the
  696.     screen is checked for changes.  If anything has changed, the change is
  697.     displayed on the PC screen.  It turned out that this was the fastest
  698.     method of updating the screen.
  699.  
  700.     I tried to update the screen at about the same time the real Spectrum
  701.     shows it on the TV screen, relative to the 50 Hz interrupt.  There is a
  702.     problem; the Spectrum takes about 1/100th of a second to generate the
  703.     whole picture, while I stop the emulator at some point in the 1/50th-
  704.     of-a-second cycle and display the whole screen at once.  Usually this
  705.     makes little difference, but with some programs it does: characters may
  706.     flicker heavily or disappear entirely (see for instance BC's Quest for
  707.     Tires).  By selecting the 'video synchronisation mode', you have some
  708.     control over the exact point of the cycle at which the screen is
  709.     updated.
  710.  
  711.     In the Hercules, CGA and Plantronics modes, not all colours can be
  712.     displayed.  In the EGA mode, all colours can be displayed, but some
  713.     colours have the same intensity in bright 1 as in bright 0.  In VGA
  714.     mode, all colours closely resemble the original Spectrum colours, and
  715.     furthermore in this mode the screen updating is the fastest of all
  716.     modes.
  717.  
  718.     The border updated every 1/50th of a second, so you cannot see the
  719.     familiar stripes when saving.  However, in real mode the emulator uses
  720.     the overscan of EGA to display the border, and you can see some stripes
  721.     there, and in VGA mode the border can be shown full-size.  The only
  722.     drawback of the border emulation in real mode is that there appears some
  723.     'snow' on the screen at each OUT - I don't know a way around this.
  724.  
  725.  
  726.     Finally, the sound emulation.  The Spectrum beeper is emulated by the
  727.     PC's internal beeper.  Because every 1/50th of a second the screen has
  728.     to be updated, and this takes a little time even if there are no
  729.     changes, the sound is a bit harsh.  If you select real mode, the
  730.     emulator won't update the screen anymore and the sound will sound
  731.     better.
  732.  
  733.     The sound of the Spectrum 128's sound chip is played through the Adlib
  734.     card; if you haven't got such a card some notes are played through the
  735.     internal speaker.  That sound will be turned off, however, as soon as
  736.     the program makes a sound through the normal speaker of the Spectrum.
  737.     Some Spectrum 128 programs use the sound chip and the beeper at the same
  738.     time, and this won't work properly without an Adlib card.
  739.  
  740.  
  741.  
  742. 2.4  Using the tape
  743.  
  744.     This emulator can load programs that are saved to tape in the usual way,
  745.     but also speed-saved programs can be loaded.  Furthermore, you can also
  746.     make a disk file act as an 'emulated tape', so that the normal SAVE and
  747.     LOAD commands can be used to transfer data to and from disk easily.
  748.  
  749.     Let's first discuss the saving and loading of programs using a tape
  750.     recorder - that'll be the first thing you want to do, to transfer your
  751.     programs to the PC.  First of all, you need an interface to connect the
  752.     tape recorder to the PC.  The parallel printer interface is used for
  753.     this.  All you need is a very simple and cheap piece of electronics to
  754.     get the input and output signals at the appropriate and safe levels; the
  755.     circuit diagram is in the program DIAGRAM.Z80.  The interface has to be
  756.     calibrated; a program to help doing this is contained in the snapshot
  757.     file.  Adjust the variable resistor so that when the tape recorder is
  758.     played at normal volume, the bar points just below 50%. When the tape
  759.     recorder is turned off, the bar should go to 0%.
  760.  
  761.     You have to tell the emulator which LPT port you use for tape I/O.  This
  762.     can be selected in the tape menu, but it can also be specified on the
  763.     command line or in the Z80.INI file with the -b switch; for instance
  764.     -b2 selects LPT2.  Default is LPT1.
  765.  
  766.     There are two ways to load programs: in 'real' or normal mode.  In real
  767.     mode, the emulator doesn't update the screen or scan the keyboard
  768.     anymore, so that the emulated Spectrum program can run smoothly.  The
  769.     emulator has to run at about 100%, but then you're able to load
  770.     everything a normal Spectrum would load, including speed-saved programs.
  771.     The only thing you see on screen are the loading bars in the border (on
  772.     EGA or VGA screens).  Real mode is selected by pressing F6. Saving
  773.     programs in real mode is a bit useless but it works; enter the SAVE
  774.     command, press a key to start saving and quickly press F6 when the
  775.     saving starts.  It will continue in real mode.
  776.  
  777.     If your computer is just fast enough, don't slow the emulator down too
  778.     much.  Because the IN instruction is relatively slow, the emulator has
  779.     to run at about 110% for the best results.  If your computer is really
  780.     fast, you can best slow it down to exactly 100%.  If your computer is
  781.     just a bit too slow, you can try to make your tape recorder run slower
  782.     too (usually you can do this by adjusting a little screw at the back of
  783.     the motor), I successfully loaded several speed-saved programs at 90%.
  784.  
  785.     In normal mode, the standard ROM loading and saving routines are
  786.     'trapped' (at addresses 04d8 and 056a) when they're about to start
  787.     saving or loading.  A routine in the emulator itself then takes over,
  788.     and loads or saves a block to tape or a disk file.  By default, this
  789.     routine uses the tape instead of a file, and I'll discuss that mode of
  790.     operation first.
  791.  
  792.     Using these SAVE and LOAD routines has a great advantage as well as a
  793.     disadvantage compared to using the Spectrum's own routines in real mode.
  794.     The advantage is that the internal routines work on every machine, no
  795.     matter how slow or fast, without having to make the emulator run at
  796.     100%.  The disadvantage at using them is that they obviously won't
  797.     understand speed-saved files.  For normal use, these internal routines
  798.     work much easier, and real mode loading is only necessary for
  799.     speed-saved and very well protected programs.
  800.  
  801.     So far for the general information about tape loading.
  802.  
  803.     The emulator uses files with the extension .TAP to hold a piece of
  804.     'tape', with several blocks on it.  Each block is usually either a
  805.     header or a data block; a normal file thus consists of two blocks. There
  806.     are two modes of operation when loading and saving to disk files, single
  807.     and multiple .TAP file mode.
  808.  
  809.     In single .TAP file mode, each block saved is appended to the end of the
  810.     .TAP file, like would happen if you were actually saving to tape. In the
  811.     same way, when loading in single file mode, each time the ROM wants to
  812.     load a block, it is presented the next block in the .TAP file. It is
  813.     handled as it would if the block was loaded from tape, that is, if the
  814.     ROM needs a header and is presented a data block, it will skip it.  The
  815.     header will however be considered to be read.  So, entering LOAD
  816.     "rubbish" will show all headers in the .TAP file, just as an ordinary
  817.     Spectrum would show all headers on the tape if you left the tape
  818.     running.
  819.  
  820.     If the last block is loaded, the file pointer is moved to the start
  821.     again.  So a .TAP file can be considered to be an infinite tape. Single
  822.     .TAP file mode is useful to save whole programs to disk, or for
  823.     multi-load games that need to load in levels as you play.
  824.  
  825.     A sort of 'random access' file management would also be useful, for
  826.     instance when you're developing a program and need to save several
  827.     pieces of data to disk and later load back a specific one.  This can be
  828.     done in single .TAP file mode (by positioning the file pointer using the
  829.     Browse function), but there's a different mode of operation that makes
  830.     things easier: multiple .TAP file mode.  In fact, by default the
  831.     emulator is in this mode.
  832.  
  833.     When the emulator is in multiple .TAP file mode, it will read all blocks
  834.     from all .TAP files in a specified directory, one after the other.  When
  835.     it has finished reading the last one, it will start all over again.
  836.  
  837.     When saving, the emulator will put the two blocks of a normal file, the
  838.     header and the data block, in one .TAP file with a unique name made up
  839.     of the printable letters of the file name and a two-digit number.  The
  840.     name of the .TAP file is irrelevant to the emulator, but to have it
  841.     resemble the name of the actual Spectrum file you saved is simply
  842.     convenient.  If the Spectrum program saves a data block to tape without
  843.     first saving a header, the .TAP file will contain only this data block,
  844.     and the DOS file name will be HDRLES, with a two-ditit number appended
  845.     to make it unique.  The format of the .TAP files saved in multiple .TAP
  846.     file mode is exactly the same as the format used in single .TAP file
  847.     mode.
  848.  
  849.     You can easily string together .TAP files; for instance a number of .TAP
  850.     files created in multiple .TAP file mode can be put into one big .TAP
  851.     file simply by copying them together, e.g.
  852.  
  853.         COPY /B FILE1.TAP + FILE2.TAP ALL.TAP.
  854.  
  855.     (Note: in some versions of DR DOS the /B switch, necessary because
  856.     otherwise copying stops after a CTRL-Z character, doesn't work properly;
  857.     load your old COMMAND.COM to copy the files).
  858.  
  859.     Now you know what you can do, but how to get the emulator to do it?
  860.     That's what the final section is about: the tape menu.
  861.  
  862.     Press F7 to enter the tape menu.  Pressing S will select or de-select
  863.     single file mode.  By default, multiple .TAP file mode is selected.  In
  864.     this case, there are three other possible choices in this menu.  First
  865.     of all, D selects a tape-file directory where the .TAP files will be
  866.     saved into and loaded from.  A default directory can be selected by
  867.     putting the -xs switch on the command line or in the Z80.INI file; for
  868.     example -xs c:\spectrum\taps selects that directory.
  869.  
  870.     The I and O options are used to select the source and destination of the
  871.     saving and loading: the LPT port for a physical tape recorder, or 'disk'
  872.     for disk files.  By default LPT1 is selected; another LPT port can be
  873.     selected with for instance -b2 or by pressing I and O.  Input and output
  874.     are directed to disk by default if a default tape file directory is
  875.     given by means of a switch on the command line or .INI file.
  876.  
  877.     If Single .TAP file mode is selected, different and more menu options
  878.     appear.  With G and P, the input and output tape files can be selected.
  879.     They may be the same.  If a specified output file already exists, you
  880.     may choose to append to or overwrite this old file.  Saving is always at
  881.     the end of the file; loading always starts at the beginning of the .TAP
  882.     file.
  883.  
  884.     With the B option - Browse - the position of the file pointer into the
  885.     input .TAP file can be changed.  If you, for instance, type LOAD""
  886.     instead of LOAD "" CODE, the first header is read, and you would have to
  887.     read all other headers before trying to load the file again.  With the
  888.     browse option you can conveniently change the file pointer.  Of every
  889.     header (that is, every block with flag byte 0 and length exactly 17) the
  890.     name and type, and of every data block the length is shown.
  891.  
  892.     The option B can also be used to delete specific blocks from a .TAP
  893.     file.  Make sure you do not only delete a data block or a header, or the
  894.     ROM may get confused! (Double data blocks will be skipped, but double
  895.     headers can generate Tape Loading errors).
  896.  
  897.     As in multiple .TAP file mode, I and O are used to specify the source
  898.     and destination for saving and loading.  If you enter a .TAP file name
  899.     with G or P, this will automatically be set correctly.  You can then
  900.     always reset the input or output back to LPTn again, of course.
  901.  
  902.     Finally, in Single .TAP file mode you can use 'tape mirroring': loading
  903.     programs from tape (in normal mode, i.e.  not using Real mode) and at
  904.     the same time saving a copy of each block loaded into a .TAP file.  This
  905.     .TAP file can later be used to load the program again, might anything go
  906.     wrong.  There are two ways of mirroring: normal mirroring and exact
  907.     mirroring.  The last one must be used only in exceptional cases; it will
  908.     always make a copy of a block, even if it had a tape error (the
  909.     corresponding block in the .TAP file will also have a tape error).  This
  910.     causes ticks in leader tones to make 0-byte blocks, so the .TAP file may
  911.     get messy.  Do not use exact mirroring if you don't really have to; I
  912.     think normal mirroring will always work in practice.
  913.  
  914.     If you try to leave the tape menu when for instance tape mirroring is
  915.     selected, and no output filename is given, the emulator will warn you
  916.     and will insist that the error be corrected.  Yes, it's stubborn!
  917.  
  918.  
  919.  
  920. 2.5  Using the microdrive
  921.  
  922.     Compared to the tape, this is really simple.  Cartridges are emulated by
  923.     files of 137923 bytes.  These files have the extension .MDR, and can
  924.     contain up to 126K of data.  The emulator emulates 8 microdrives, the
  925.     maximum amount the Interface I software can handle, and each of these
  926.     cartridge files can be inserted in any of the 8 microdrives.  (Do not
  927.     insert one file into more than one microdrive; this will cause problems
  928.     with the buffering done by the emulator as well as the Interface I, and
  929.     might result in data loss).
  930.  
  931.     Press F8 to enter the microdrive menu.  Press 1 to 8 to select a
  932.     microdrive, and I to insert a microdrive cartridge.  You can select an
  933.     existing one, or type a new name.  If the cartridge file isn't found,
  934.     the emulator asks whether it should create it.  When created, you'll
  935.     have to format it first; if you don't, you'll get a 'microdrive not
  936.     present' error when you try to read it, just as happens with real
  937.     unformatted cartridges.  To format a cartridge, type
  938.  
  939.         FORMAT "m";1;"name"
  940.  
  941.     After this the cartridge should have 126K of free space.
  942.  
  943.     The cartridge can be write protected; see the menu option in the F8
  944.     menu.  This is a characteristic of the cartridge, and the write protect
  945.     tab information is therefore stored in the cartridge file.
  946.  
  947.     As on the real Spectrum, you'll have to be careful with OUT's if a
  948.     cartridge is inserted.  Try OUT 239,0 (on a real Spectrum, this turns on
  949.     the microdrive motor) and wait a few seconds; most of your data will be
  950.     lost!  You can stop the microdrive motor by typing STOP (or, more
  951.     generally, generate an error).
  952.  
  953.     The microdrives are emulated at IN/OUT level.  This means that every
  954.     utility or program that uses microdrives ought to work on the emulator.
  955.     Most utilities use hook codes, and these will certainly work.
  956.  
  957.     The GAP line is emulated; this signal is activated if the interface I
  958.     senses a piece of tape with no data on it.  If the checksum of the first
  959.     header block of a microdrive header or data block is not correct, that
  960.     block is considered to be a GAP.  This will only happen if some utility
  961.     writes a bad block to microdrive deliberately, if the file is newly
  962.     created and unformatted, or when you type OUT 239,0.
  963.  
  964.  
  965.  
  966. 2.6  Using the RS232 channel
  967.  
  968.     This was the only Spectrum i/o channel that could be used in the early
  969.     versions of the emulator.  Using .TAP files instead of the RS232 channel
  970.     is often easier, but sometimes using the RS232 channel can be very
  971.     useful too, for instance if you've got a null-modem lead that connects a
  972.     Spectrum with interface I to the PC you can use it to transfer data and
  973.     programs easily.  Furthermore, the RS232 channel is the easiest way to
  974.     let the emulator communicate with a PC printer.
  975.  
  976.     The Interface I RS232 port is called the "B" or "T" channel.  The first
  977.     is the binary channel, the "T" channel won't let all control codes
  978.     through and will expand any keyword; useful for LISTing a program but
  979.     otherwise annoying.
  980.  
  981.     The Spectrum 128 has its own RS232 port; it is called the "P" channel.
  982.     Output to either the Interface I's or Spectrum 128's own RS232 port will
  983.     all be processed as 'RS232 output', and input will go to both (that is,
  984.     to the one you happen to read from).
  985.  
  986.     The output to the RS232 channel can be routed to an LPT port, to a COM
  987.     port or to a file on disk.  Input can come from either a file or a COM
  988.     port.
  989.  
  990.     If you want to use the RS232 channel for printing using LPRINT and LLIST
  991.     (shorthand for PRINT #3 and LIST #3), be sure to open that channel for
  992.     output to RS232; by default it sends its output to the ZX Printer, which
  993.     is not supported.  You can open the channel by typing OPEN #3,"B" (or
  994.     "T" for listings, or "P" on a Spectrum 128).
  995.  
  996.     Input and output are buffered.  This is important to remember when
  997.     you're transferring files using the SAVE and LOAD *"b" commands of the
  998.     Interface I.  If the header is missed, for instance if you try to load
  999.     the wrong file type, re-sending the file will not directly work because
  1000.     there will still be bytes in the buffer.  You have to clear the input
  1001.     buffer before re-sending the file.  When inputting from a disk file, the
  1002.     file pointer can be reset to point to the start of the file again to
  1003.     re-read the header.
  1004.  
  1005.     When inputting or outputting from or to a disk file, the read or write
  1006.     position is displayed as a byte-count.  An <EOF> sign will appear if an
  1007.     input file is read completely through to the end.
  1008.  
  1009.     The RS232 redirection options are in the Change Settings (F4) menu.  The
  1010.     menu options are pretty obvious if you keep above remarks in mind, so I
  1011.     won't go into that.
  1012.  
  1013.     When using a COM port, make sure you have initialised it before starting
  1014.     the emulator with the Dos MODE command, for instance
  1015.  
  1016.         MODE com1:96,n,8,1
  1017.  
  1018.     initialises COM1 to send and receive at 9600 baud, no parity, 8 data
  1019.     bits and 1 stop bit, the default for the Interface I.
  1020.  
  1021.     Here is how to transfer programs from a Spectrum to the PC using the
  1022.     RS232 lead.  First, you need a null-modem lead.  I myself use the
  1023.     following cable:
  1024.  
  1025.           Spectrum                                  'AT'      'PC'
  1026.           (9 pins)                                (9 pins)  (25 pins)
  1027.  
  1028.             3 TxD   ───────────────────────── RxD     2         3
  1029.  
  1030.             4 DSR   ───────────────────────── DTR     4        20
  1031.  
  1032.                                         ┌──── CTS     7         4
  1033.                                         └──── RTS     8         5
  1034.  
  1035.             7 GND   ───────────────────────── GND     5         7
  1036.  
  1037.     (so CTS and RTS have to be connected!) This is not a full null-modem
  1038.     lead; you can only send data from the Spectrum to a PC.  Here's how to
  1039.     transfer: load the program SAVESPEC.Z80 in the emulator and type the
  1040.     basic program over into the real Spectrum, and run it.  It saves a short
  1041.     piece of code to tape.
  1042.  
  1043.     Now load the program you want to transfer, and stop it.  (This may be
  1044.     tricky!)  Load the code back into memory at address 16384 (the code is
  1045.     relocatable but this is the safest place):
  1046.  
  1047.         LOAD "RS232" CODE 16384
  1048.  
  1049.     Now open channel three for output to RS232; on a Spectrum with Interface
  1050.     I this would be OPEN #3,"b", on a Spectrum 128 it would be OPEN #3,"p",
  1051.     and with other interfaces you'll probably know what to do. Select the
  1052.     right baud rate on the Spectrum (probably FORMAT "b",9600 or something
  1053.     like that).  Now initialise the appropriate COM port on the PC and type
  1054.  
  1055.         GETRS /n filename.z80           (n=COM port used)
  1056.  
  1057.     at the DOS prompt, and then type RANDOMIZE USR 16384 to send the whole
  1058.     memory over to the PC.  The resulting .Z80 file should now be exactly
  1059.     49182 bytes long (that is 48K+30 bytes), if not try again or try a lower
  1060.     baud-rate.  Voila, transferred!
  1061.  
  1062.     To transfer short blocks of data it's often easier to use the LOAD *"b"
  1063.     and SAVE *"b" commands of the Interface I.  When the right options have
  1064.     been selected in the RS232 i/o redirection menu, you should just follow
  1065.     the instructions of the Interface I user manual and all should work as
  1066.     expected.
  1067.  
  1068.  
  1069.  
  1070. 2.7  Joysticks
  1071.  
  1072.     As was already said in the introduction, the emulated Spectrum joystick
  1073.     (Cursor, Interface 2 or Kempston) is controlled by the PC cursor keys
  1074.     and 5/0/.  on the numeric keypad and TAB as fire keys.  The emulated
  1075.     joystick can also be controlled by a real joystick, both an analogue (PC
  1076.     standard) or a digital one.
  1077.  
  1078.     The analogue joystick support is rather straightforward.  If you've got
  1079.     one, it works - it couldn't be simpler.  The digital joystick support is
  1080.     less obvious, since PC's don't support these.
  1081.  
  1082.     To use digital joysticks, Ruud Zandbergen has made a device that uses
  1083.     the two inputs of a normal analogue joystickinterface to connect a
  1084.     digital joystick to a PC.  Here's the circuit diagram:
  1085.  
  1086.  
  1087.     15 pins male  (pc)                           9 pins male (joystick)
  1088.  
  1089.  
  1090.     1+9 <─────────┬───────────┬────────────┬─────────────┬──> 7 (5V)
  1091.                  ┌┴┐         ┌┴┐          ┌┴┐           ┌┴┐
  1092.         4 x 1 kΩ │ │ ¼ Watt  │ │          │ │           │ │
  1093.                  └┬┘         └┬┘          └┬┘           └┬┘
  1094.     3   <─────────┴──> 4 (up) │            │             │
  1095.                               │            │             │
  1096.     6   <─────────────────────┴──> 3 (dwn) │             │
  1097.                                            │             │
  1098.     13  <──────────────────────────────────┴──> 1 (rght) │
  1099.                                                          │
  1100.     11  <────────────────────────────────────────────────┴──> 2 (lft)
  1101.                        ┌────────────────────┐
  1102.     2   <──────────────┤    47 Ω ¼ Watt     ├───────────────> 6 (fire)
  1103.                        └────────────────────┘
  1104.     4+5+14 <────────────────────────────────────────────────> 8 (0V)
  1105.  
  1106.  
  1107.     4+5+14 means: connect pins 4, 5 and 14.  The same applies for pins 1 and
  1108.     9.  Here's the list of ingredients:
  1109.  
  1110.         1 x 9 pins D plug, male
  1111.         1 x 15 pins D plug, male
  1112.         4 x 1kΩ , ¼ Watt resistors
  1113.         1 x 47 Ω, ¼ Watt resistor
  1114.         piece of 7-wire flatcable
  1115.  
  1116.     Everything can be fit into the 15-pins plug.  Make sure the resistors
  1117.     don't touch the other blank connections!  This interface can be used for
  1118.     all usual digital joysticks, with or without auto fire (that is every
  1119.     joystick that work with a Kempston joystick interface, or that work on a
  1120.     Commodore 64/Amiga or Atari).  The joysticks for the Spectrum +2/+3 will
  1121.     not work, however the pin layout is easy to change.
  1122.  
  1123.     This joystickinterface needs an analogue PC-joystickinterface on which
  1124.     you can connect TWO analogue joysticks (on one plug!).  Most cards can
  1125.     do this, but some multi-I/O cards support only one joystick.  Check the
  1126.     documentation of your I/O card to see whether your joystickinterface is
  1127.     suitable.  The soundblaster joystick interface works fine.
  1128.  
  1129.     A number of PC games will behave strange when the digital joystick
  1130.     interface is connected; they run very slow or crash.  When this happens,
  1131.     remove the joystick interface (not only the joystick!).
  1132.  
  1133.  
  1134.  
  1135. 2.8  Transferring programs
  1136.  
  1137.     There are a number of ways to transfer programs from the Spectrum to the
  1138.     PC: loading them directly from tape, using the RS232 lead or
  1139.     transferring from disks of Spectrum disk interfaces.  And then you might
  1140.     have snapshot files from other emulators that you want to convert to
  1141.     .Z80 files.  I'll discuss these cases one after the other.
  1142.  
  1143.     Converting using the COM port is not so easy most of the times, but if
  1144.     you've got a null-modem lead waiting to do something you could read
  1145.     section 2.6.  Luckily, there are easier ways.
  1146.  
  1147.     First of all, you can use the tape.  If you want to do this, then the
  1148.     first thing to do is to read section 2.4 carefully - now you know almost
  1149.     everything you need.  Most programs you have probably use the normal
  1150.     tape format; you will find that these usually load right away. If the
  1151.     programs use speed-load, using real mode will probably load most of
  1152.     these right away too.
  1153.  
  1154.     But some programs are really cleverly protected, and use obscure
  1155.     features of the Z80 processor.  To run these programs, turn on LDIR
  1156.     emulator and R register emulation (see the 'Change Settings' menu, F4).
  1157.     Note that the emulator will slow down a bit when R register emulation is
  1158.     selected; if you need to use real mode then make sure you speed the
  1159.     emulator up again to 100%.  After the program has loaded successfully,
  1160.     you may try to turn R register emulation off again; I don't know any
  1161.     program that needs R register emulation after loading.  Read chapter 5
  1162.     for more technical information about these options.
  1163.  
  1164.     If you've got Spectrum disks, you will probably be able to convert the
  1165.     programs on them to a useful format and use them in the emulator.  The
  1166.     registered package of this emulator contains a program DISCIPLE, that
  1167.     can read DISCiPLE and Plus D disks and convert the snapshots and other
  1168.     files on it to .TAP and .Z80 files.  The previous version of this
  1169.     program could only read 3.5'' Disciple disks, and had several bugs in
  1170.     the file and snapshot translation routines.  So if you transferred
  1171.     programs with the old DISCIPLE program and they don't work, don't blame
  1172.     the emulator but try to transfer them again with the new program.
  1173.  
  1174.     The current version of the DISCIPLE program reads 3.5'' as well as
  1175.     5.25'' DISCiPLE disks, will translate 48K, 128K and screen snapshots,
  1176.     and other normal files.  The previous version used the .SAV file format
  1177.     for normal files, which could be loaded into the emulator using LOAD
  1178.     *"b"; this version converts them into .TAP files which can be loaded
  1179.     simply by using the normal tape LOAD statements (see 2.4).
  1180.  
  1181.     If you have got a Beta disk interface, your problem is solved too. J.L.
  1182.     Bezemer wrote a program called BDDE that reads Beta disks.  The program
  1183.     can be downloaded from the Spectrum emulator support BBS.
  1184.  
  1185.     Finally, maybe you were using another Spectrum emulator for the PC
  1186.     before using this one, and you may have already got a collection of
  1187.     snapshot or other files.  CONVZ80, another utility for registered users,
  1188.     can convert between several snapshot formats, namely the .SNA format of
  1189.     JPP, the .SP formats of VGASPEC and SPECTRUM, the .PRG files of SpecEm,
  1190.     and the .Z80 format of course.  (It is by the way not necessary to
  1191.     convert .SNA files, the emulator can read them as they are.)  CONVZ80
  1192.     can also convert the tape files used by SpecEm and ZX to .TAP files.
  1193.     CONVZ80 recognizes what it should do by the extension of the files you
  1194.     enter on the command line; to distinguish between VGASPEC's and
  1195.     SPECTRUM's .SP formats you can use the switch -o.  If the extension
  1196.     consists of digits only, it is taken to be a ZX tape file, and if it
  1197.     contains non-digits and is none of .SP, .Z80, .SNA, .PRG or .TAP it is
  1198.     regarded as a SpecEm tape file.
  1199.  
  1200.     SpecEm can load .PRG snapshot files, but cannot save them.  However, it
  1201.     emulates the Multiface I, which can save snapshots to tape.  SpecEm will
  1202.     save these blocks as tape files to disk.  If you convert these to a .TAP
  1203.     file (in the correct order!), you can load them into Z80 and save the
  1204.     program as a .Z80 file.
  1205.  
  1206.  
  1207.  
  1208. 2.9  Converting file formats - the utility CONVERT
  1209.  
  1210.     This section is about the utility CONVERT, which can convert some of the
  1211.     Spectrum's own format into each other, and also converts some of the
  1212.     emulator's formats into others.  It is not about converting files from
  1213.     other emulators; read section 2.8 if you want to know about that.
  1214.  
  1215.     CONVERT was useful when the emulator could only communicate with
  1216.     snapshot files and the RS232 link.  It has become less useful now, with
  1217.     .TAP files, but it still has some useful features.
  1218.  
  1219.     It can read three types of input files: pure ASCII, pure bytes (for
  1220.     instance a .SCR screen dump), and files produced by a SAVE *"b" command.
  1221.  
  1222.     Output is pure bytes, ASCII with either CR (Spectrum standard) or CR/LF
  1223.     (PC standard) for line breaks, SAVE *"b" files containing a Basic or
  1224.     code file, a .PCX or a .GIF file.
  1225.  
  1226.     So what can you do? Main uses are adding LF (10 hex) bytes to a text
  1227.     file produced by the Spectrum; converting a code block into a SAVE *"b"
  1228.     to load it into the Spectrum using LOAD *"b" (and the reverse of course:
  1229.     converting a SAVE *"b" file to pure bytes), and converting a screen dump
  1230.     to .PCX or .GIF graphics files.
  1231.  
  1232.     Less useful, but possible: LISTing a program (SAVE *"b" file) to produce
  1233.     readable ASCII, and the reverse: converting an ASCII listing to
  1234.     executable Basic again.
  1235.  
  1236.     If you want to make a .PCX or a .GIF file, input should be a SAVE *"b"
  1237.     file of a screen (length 6921 bytes exactly) or a bare .SCR screendump
  1238.     (length 6912 bytes).  You can make screendumps by selecting the X-Extra
  1239.     functions menu from the main menu.
  1240.  
  1241.  
  1242.  
  1243. 2.10  The utilities Z802TAP and TAP2TAPE
  1244.  
  1245.     The SamRam has built in it some snapshot software.  Using this software
  1246.     you can save any 48K Spectrum program to tape or to a .TAP file, as is
  1247.     explained in section 3.2 below.  But the SamRam software cannot handle a
  1248.     128K program.
  1249.  
  1250.     The utility that can convert a 128K snapshot (and 48K ones for that
  1251.     matter) to a .TAP file is called Z802TAP.  The .TAP file includes a
  1252.     basic loader, and a loading screen if you want.  Z802TAP compresses the
  1253.     blocks it writes (using a better method than used in compressing .Z80
  1254.     files) to save loading time.  If you don't want it to compress the
  1255.     blocks, for instance when you want to take a look at the ram pages of
  1256.     the Spectrum 128, specify -u when you run Z802TAP.  You can load the
  1257.     converted program simply by executing
  1258.  
  1259.         Z80 -ti tapefile
  1260.  
  1261.     and typing LOAD "" (for a 48K program) or changing the hardware mode to
  1262.     Spectrum 128 and choose 'Tape Loader' in the menu.
  1263.  
  1264.     The program TAP2TAPE writes .TAP files back to tape.  The program
  1265.     consists of a batch file TAP2TAPE.BAT, which executes the TAP2TAPE.Z80
  1266.     file using the emulator.  The .TAP file is written to tape exactly as it
  1267.     is, so that if a block contains a tape error, it won't load correctly
  1268.     from tape either.  If the entire .TAP file has been saved the emulator
  1269.     will start loading from tape.  At that point, press space once to return
  1270.     to DOS.
  1271.  
  1272.  
  1273.  
  1274.  
  1275. 3.  THE SAMRAM
  1276.  
  1277.  
  1278. 3.1  Basic extensions
  1279.  
  1280.     The SamRam is a hardware device Johan and I built for our Spectrums.  It
  1281.     consists of a 32K static RAM chip which contains a modified copy of the
  1282.     normal Basic ROM and a number of other useful routines, like a monitor
  1283.     and snapshot software.  You can compare it to a Multiface I interface,
  1284.     but it's more versatile.  Another useful feature was a simple hardware
  1285.     switch which allowed use of the shadow 32K Ram, present at 8000-FFFF in
  1286.     most Spectrums, but hardly ever actually used.
  1287.  
  1288.     For more details on the low-level hardware features of the SamRam read
  1289.     chapter 5.  In this chapter I'll explain the software features of the
  1290.     SamRam software, somewhat bombastically called the 'SamRam 32 Software
  1291.     System' or the 'Sam Operating System'.  By the way, all similarity
  1292.     between existing computers is in fact purely coincidental and has in no
  1293.     way been intended.  Really!
  1294.  
  1295.     The SamRam offers a few new Basic commands, and a lot of useful routines
  1296.     that are activated by an NMI, i.e.  by pressing F5.  First I'll discuss
  1297.     the Basic extension.
  1298.  
  1299.     Select the SamRam by starting the emulator with the -s switch, or by
  1300.     selecting it from the F9 menu.  Normal Basic functions as usual; the
  1301.     character set is different from the original one.  There are four new
  1302.     commands: *RS, *MOVE, *SAVE and *SPECTRUM, and two new functions, DEC
  1303.     and HEX, which have replaced ASN and ACS.  DEC takes a string argument
  1304.     containing a hexadecimal number, and returns the decimal value of it.
  1305.     HEX is the inverse of the DEC function, and yields a four-character
  1306.     string.
  1307.  
  1308.     *RS sends its arguments directly to the RS232 channel.  You don't have
  1309.     to open a "b" or "t" channel first.  You're right, it's of limited use.
  1310.     Example: *RS 13,10
  1311.  
  1312.     *MOVE is useful: it moves a block of memory to another place.  Example:
  1313.     *MOVE 50000,16384,6912 moves a screen-sized block from 50000 to the
  1314.     start of the screen memory.
  1315.  
  1316.     *SAVE works like *MOVE, except that it activates the shadow SamRam ROM
  1317.     before moving.  I used this command to update the shadow ROM, but on the
  1318.     emulator you can use it to move the shadow ROM to a convenient place in
  1319.     Ram where you can take a look at it, for instance by executing
  1320.     *SAVE 0,32768,16384.
  1321.  
  1322.     *SPECTRUM resets the SamRam Spectrum to a normal one.  You lose all data
  1323.     in memory.  By resetting the emulator by pressing ALT-F5, the SamRam is
  1324.     activated again.  Not very useful either.
  1325.  
  1326.     Then there's the Ramdisk, which is, like the Spectrum 128 ramdisk,
  1327.     accessed via the SAVE!, LOAD!, CAT!, ERASE! and FORMAT!.  The syntax is
  1328.     straightforward.  FORMAT! and CAT! need no parameters; ERASE! only needs
  1329.     a name.  If a file is not found, the SamRam will respond with a 5-End of
  1330.     File error.  The Ramdisk has a capacity of 25K.
  1331.  
  1332.  
  1333.  
  1334. 3.2  The NMI software
  1335.  
  1336.     Select the SamRam (F9-3), and press F5.  A menu with eight icons pops
  1337.     up.  You can select each icon by moving the arrow to it (using the
  1338.     cursor keys or the Kempston joystick), and pressing '0' or fire.  The
  1339.     icons can also be selected by pressing the appropriate letter key.
  1340.  
  1341.     The eight icons are two arrows with N and E within them, a magnifying
  1342.     glass with the letters 'mc' in it (activated by pressing D), two screens
  1343.     (identified by 1 and 2), a printer (P), a cassette (S) and a box saying
  1344.     'overig'.  The 'D' activates the monitor or disassembler; read section
  1345.     3.3 for information on this program.
  1346.  
  1347.     Pressing N or E returns you to the Spectrum.  If you pressed N, the
  1348.     normal Spectrum rom will be selected when the NMI software returns; if
  1349.     you press E, the Rom with the Basic extensions will be selected.  Some
  1350.     games may crash if they see a different rom than the standard Spectrum
  1351.     one.
  1352.  
  1353.     Pressing 1 selects the tiny screen editor.  You can move a '+' shaped
  1354.     cursor about the screen using the cursor keys.  The following commands
  1355.     are available:
  1356.  
  1357.         H: Get the current ATTR color from the screen at the cursor's
  1358.            current position, and store it in memory.  This color will be
  1359.            used by the next command:
  1360.         Z: Put the color on the screen
  1361.         G: Get a character from the screen
  1362.         P: Put the character on the screen
  1363.         R: Remove all screen data that is invisible by the ATTR color
  1364.         L: Take a look at the bitmap below the ATTR color codes
  1365.         T: Return to the main menu.  You can also return by pressing
  1366.            EDIT, or ESC in the emulator.
  1367.         B: Change border color
  1368.         V: Clear the whole screen
  1369.  
  1370.     If you press 0, you can edit the current 8x8 character block at pixel
  1371.     level.  Again you control the cursor with the cursor keys.  Now 0
  1372.     toggles a pixel.  In this mode there are two commands: C clears the
  1373.     whole block, and I inverts it.  Pressing EDIT (ESC) returns you to the
  1374.     big screen again.
  1375.  
  1376.     The SamRam has two screen buffers.  Buffer 1 is used to hold the screen
  1377.     which was visible when you pressed NMI, to be able to restore it when
  1378.     returning.  This is the screen you edit with '1'.  The second screen
  1379.     buffer can be used to hold a screen for some time; it is not touched by
  1380.     the NMI software directly, and will not even be destroyed by a Reset. If
  1381.     you press '2', a menu appears with four Dutch entries:
  1382.  
  1383.         1: Scherm 1 opslaan        (Store screen 1 into buffer 2)
  1384.         2: Scherm 2 veranderen     (Edit screen 2)
  1385.         3: Schermen verwisselen    (Swap screens)
  1386.         4: Scherm 2 weghalen       (Remove screen 2)
  1387.  
  1388.     These four functions are rather obvious, I believe.
  1389.  
  1390.     Pressing 'P' pops up the printer menu.  The screendump program is
  1391.     written specifically for my printer, a Star SG-10.  It will probably
  1392.     work on some other printers, but not on most.  The output is sent to the
  1393.     RS232 channel, so you have to redirect it to an LPT output.
  1394.  
  1395.     Skipping the most interesting, 'S', for a moment, let's first discuss
  1396.     the final menu, 'O' for 'Overig', Dutch for miscellaneous.  There are
  1397.     five menu options, of which three are not useful.  The first gives a
  1398.     directory of the cartridge currently in Microdrive 1.  The last, 'E',
  1399.     returns you to Basic if this is anywhere possible: it resets some
  1400.     crucial system variables and generates a Break into Program.  You can
  1401.     use this for instance to break in a BEEP, or crack a not-so-very-well-
  1402.     protected program.  The three other options select normal or speed-
  1403.     save, and store the current setting in CMOS Ram.  Speed-save won't work
  1404.     properly on the emulator, because the speed-save routine toggles the
  1405.     upper 32K ram bank regularly, and this takes too much time on the
  1406.     emulator.  The setting is not important if you use the internal save
  1407.     routine (which will be used by default, unless you select Real Mode).
  1408.  
  1409.     Finally, the 'S' option.  This option allows you to save a snapshot to
  1410.     tape or microdrive.  I used it a lot on my real Spectrum, and it works
  1411.     just as well on the emulator.  It is very useful is you want to load a
  1412.     .Z80 program back into a real Spectrum again.  There are three
  1413.     'switches' you can toggle.  The active choice is indicated by a bright
  1414.     green box, inactive boxes are non-bright.  You have to use EGA or VGA to
  1415.     be able to see it...  The first switch lets you select whether the
  1416.     SamRam rom should be active if the program loads or not.  This is only
  1417.     meaningful is you load it back in a SamRam again.  Usually I want the
  1418.     SamRam rom to be active because I like the character set better.  The
  1419.     second switch indicates whether the SamRam should save a 'loading
  1420.     screen', which it takes from screen buffer 2.  If screen buffer 2
  1421.     contains a screen, this switch will by default be on.  Finally, the last
  1422.     switch lets you select the output media, tape or cartridge.
  1423.  
  1424.     If the program is loaded back into the SamRam, the only bytes that have
  1425.     been corrupted are four bytes down on the stack; this will virtually
  1426.     never be any problem.  If the program is loaded back to a normal
  1427.     Spectrum, these four bytes will also be corrupted, and the bottom two
  1428.     pixel lines of the screen will be filled with data.  (This is
  1429.     considerably less than any other snapshotter I've seen: for instance the
  1430.     Multiface I uses more than 35% of the screen!)
  1431.  
  1432.     The Microdrive BASIC loader needs code in the SamRam rom to start the
  1433.     program (the RANDOMIZE USR 43 calls it).  It won't be very difficult to
  1434.     write a standard BASIC loader that doesn't need this code, but I don't
  1435.     think many people desperately need it...
  1436.  
  1437.  
  1438.  
  1439. 3.3  The built-in monitor
  1440.  
  1441.     This is a really very convenient part of the emulator, and I use it a
  1442.     lot.  It is very MONS-like in its commands and visual appearance.  It
  1443.     cannot single-step however, but on the positive side it has some
  1444.     features MONS hasn't.  It is a part of the SamRam, and cannot therefore
  1445.     be used with Spectrum 128 programs.  If you want to take a look at a
  1446.     Spectrum 128 program, press F10, then change the hardware to SamRam
  1447.     without resetting, and finally generate an NMI in the Extra Functions
  1448.     menu.  You won't probably be able to continue to run the program, but at
  1449.     least you're able to see what it was doing.
  1450.  
  1451.     Press F5 for NMI, and D to enter the monitor/disassembler.  The first
  1452.     eight lines are the first eight instructions, starting at the Memory
  1453.     Pointer, from here on abbreviated by MP.  At first, MP is zero.  The
  1454.     disassembler knows all official instructions, and the SLL instruction.
  1455.     If another inofficial instruction (i.e.  starting with DD, FD or ED) is
  1456.     encountered, the first byte is displayed on a blank line.  The four
  1457.     lines below these display the value of PC and SP, the first nine words
  1458.     on the stack (including AF and the program counter, which have been
  1459.     pushed during NMI), and three MP-memories.  These can be used for
  1460.     temporary storage of the MP, for instance when you take a look at the
  1461.     body of a CALL, and want to return to the main procedure later.
  1462.  
  1463.     The bottom part of the screen displays 24 bytes around the memory
  1464.     pointer.
  1465.  
  1466.     Commands are one letter long; no ENTER needs to be given.  If one or
  1467.     more operands are needed, a colon will appear.  By default the monitor
  1468.     accepts hexadecimal input.  A leading $ denotes that the number is to be
  1469.     regarded as decimal.  If you give the # command, the default will toggle
  1470.     to decimal, and you need to explicitly put a # in front of a number
  1471.     which is to be interpreted as a hex number.  Also, after the # command
  1472.     all addresses on screen will be decimal.  A single character preceded by
  1473.     the " symbol evaluates to its ASCII code, and the single character M
  1474.     will evaluate to the current value of the memory pointer.
  1475.  
  1476.     The monitor commands:
  1477.  
  1478.         Q: Decrease the memory pointer by one.  You effectively shift one
  1479.            byte up.
  1480.         A: Increase the memory pointer, shifting one byte down.
  1481.         ENTER: Shift one instruction down: the memory pointer is
  1482.            increased by the length of first instruction displayed on
  1483.            screen.
  1484.         M: Change the value of the memory pointer.  For instance, M:M
  1485.            won't change it.
  1486.         P: Put.  The word operand supplied will be stored in the first MP
  1487.            memory, and the others will shift on place to the right.
  1488.            Usually, you'll want to store the memory pointer by P:M
  1489.         G: Get.  Typing G:1, G:2 or G:3 moves the value of one of the MP
  1490.            memories to the MP.
  1491.         B: Byte.  This command needs a byte operand; it will be poked
  1492.            into memory, and the memory pointer will move one up.
  1493.         I: Insert.  The same as B, except that you can poke more than one
  1494.            byte.  It continues to ask for bytes to poke until you type
  1495.            Enter on a blank line.
  1496.         #: Toggles the default number base between hexadecimal and
  1497.            decimal.
  1498.         F: Find.  You can enter up to ten bytes, which will be searched
  1499.            through memory.  Searching will stop at address 0, because
  1500.            since the search string is stored in shadow Ram, searching
  1501.            would otherwise not always terminate.  Typing Enter on a blank
  1502.            line starts the search.  Byte operands are entered as usual,
  1503.            but:
  1504.            - If a number bigger than 256 decimal is entered, it is
  1505.              treated as a word in the standard LSB/MSB format.  So, 1234
  1506.              will search for 34,12 hex in that order.  Note that 0012
  1507.              will search for 12, not 12,00.
  1508.            - A line starting with " decodes into the string of characters
  1509.              (up to ten) behind it.  Normally this would only be the
  1510.              first character.  So instead of typing "M "Y "N "A "M "E
  1511.              (space=enter here) you type "MYNAME.  Note that any
  1512.              terminating " will also be searched for!
  1513.            - An x is treated as a wildcard.  So if you search for CD x 80
  1514.              any call to a subroutine in the block 8000-80FF is a hit.
  1515.              If you search for x 8000, you'll see every one-byte
  1516.              instruction that has the address 8000 as operand.
  1517.         N: Continues the search started by F from the current MP.
  1518.         $: Displays one page of disassembly on screen.  In this mode,
  1519.            the following commands are possible:
  1520.            $: Back to the main screen
  1521.            7: [Shift 7 also works, cursor up]: Go to the previous page.
  1522.               The monitor stores the addresses of the previous eight
  1523.               pages only.
  1524.            Q: Go back one byte (decrease MP by one)
  1525.            A: Go one byte forward (increase MP by one)
  1526.            Z: Dump this screen to the printer, in ASCII format.  Redirect
  1527.               the RS232 output to a file, and run CONVERT on it to convert
  1528.               the CR's into CR/LF's before printing (or tell your printer
  1529.               to do the conversion).
  1530.            Every other key displays the next page of disassembly.
  1531.         K: List.  The same mode as with $ is entered, but instead of a
  1532.            disassembly the bytes with their ASCII characters are
  1533.            displayed.  Useful to look for text.
  1534.         C: Clear.  Fills blocks of memory with a specified value.  The
  1535.            monitor prompts with 'First', 'Last' and 'With'.  The 'Last'
  1536.            address is inclusive!
  1537.         D: Dump.  Prompts with 'First' and 'Last', and dumps a
  1538.            disassembly of the block between these addresses to the
  1539.            printer.  See remark at $-Z.  The 'Last' address is again
  1540.            inclusive.
  1541.         R: Registers.  If you press Enter after R, an overview of the
  1542.            registers contents is displayed.  If you type one of A,B,C,D,
  1543.            E,H,L,A',B',C',D',E',H',L',I,R,AF,BC,DE,HL,AF',BC',DE',HL',
  1544.            IX,IY,SP or PC, you can change the value of it.  Changing the
  1545.            value of SP also changes the PC and AF values by the way.  You
  1546.            cannot change the Interrupt mode or IFF.
  1547.         V: Verplaats.  (Move).  Prompts with 'From', 'To' and 'Length'.
  1548.            Obvious.
  1549.         S: Save.  Enter the start of the block you wish to save first.
  1550.            The monitor then prompts with 'Length'.  The block is saved
  1551.            without a header, as a normal data block (A, the flagbyte, is
  1552.            0FF)
  1553.         L: Load.  Loads a block of data from tape, at the specified
  1554.            address.  Normal data blocks, headers and blocks with non-
  1555.            standard flag bytes can be loaded.  The first byte in memory
  1556.            will contain the flag byte.  If the checksum isn't 0 after
  1557.            loading, indicating a tape error, you'll hear a beep.
  1558.         H: Header read.  Loads headers and displays the contents on
  1559.            screen.
  1560.  
  1561.  
  1562.     As you're reading this part, I assume you know something of machine
  1563.     code.  Probably you would be interested in peeking into the software of
  1564.     the SamRam, the Interface I or the Spectrum 128.  You'll first have to
  1565.     move these roms in ram to be able to look at them with the monitor.
  1566.  
  1567.     The Interface I rom can be moved into ram by saving it to microdrive or
  1568.     to the "b" channel, with SAVE *"m";1;"rom" CODE 0,8192 or SAVE *"b" CODE
  1569.     0,8192, and loading it back again at 32768 for instance.  You can also
  1570.     put this small machine code routine at 23296 and run it: F3 21 0C 5B E5
  1571.     21 00 00 E5 C3 08 00 21 00 00 11 00 80 01 00 20 ED B0 FB C3 00 07.
  1572.  
  1573.     The two SamRam roms are easy.  The first you don't need to transfer; the
  1574.     monitor looks at the extended basic rom by default.  The second rom can
  1575.     be moved to 32768 by typing *SAVE 0,32768,16384.  (The SAVE is not the
  1576.     keyword SAVE!)
  1577.  
  1578.     The first '128 rom, the one which is active at reset and contains most
  1579.     of the new code, is moved up by typing SAVE!"rom"CODE 0,16384, then
  1580.     LOAD!"rom"CODE 32768.  The other rom is most conveniently moved by
  1581.     saving it to a .TAP file and loading it back again in ram.  To select
  1582.     the SamRam type SPECTRUM first, and then switch the hardware without
  1583.     resetting.
  1584.  
  1585.  
  1586.  
  1587.  
  1588. 4.  THE SPECTRUM
  1589.  
  1590.  
  1591. 4.1  The Spectrum
  1592.  
  1593.     This emulator supports the Interface I and the Spectrum 128.  Many
  1594.     Spectrum users will have no experience with them, so some comments may
  1595.     be useful.  On the other hand, I don't think this is the right place to
  1596.     describe the Spectrum Basic in full detail.  If you want to know it all,
  1597.     read the official manuals!
  1598.  
  1599.     If you want to use Spectrum Basic, you will need the keywords.  You
  1600.     could by the way now also use the Spectrum 128 Basic where you can type
  1601.     the keywords in by full.
  1602.  
  1603.     If you press ALT-F1 in the emulator, the Spectrum keyboard layout will
  1604.     appear.  For completeness I include an alphabetical list of all keywords
  1605.     and their key-combination.  In the list below, K stands for Keyword
  1606.     mode, E for E-mode (type Shift-Alt of Shift-Ctrl to select E-mode), S
  1607.     for Symbol Shift, and SE for Symbol Shifted (Alt/Ctrl) E-mode: select E
  1608.     mode and type the letter while depressing Symbol Shift.
  1609.  
  1610.  
  1611.         Keyw.    Code | Keyw.    Code | Keyw.    Code | Keyw.    Code
  1612.  
  1613.         ABS      E g    DRAW     K w    MERGE    SE t   SAVE     K s
  1614.         ACS      SE w   ERASE    SE 7   MOVE     SE 6   SCREEN$  SE k
  1615.         AND      S y    EXP      E x    NEW      K a    SGN      E f
  1616.         ASN      SE q   FLASH    SE v   NEXT     K n    SIN      E q
  1617.         AT       S i    FN       SE 2   NOT      S s    SQR      E h
  1618.         ATN      SE e   FOR      K f    OPEN #   SE 4   STEP     S d
  1619.         ATTR     SE l   FORMAT   SE 0   OR       S u    STOP     S a
  1620.         BEEP     SE z   GO SUB   K h    OUT      SE o   STR$     E y
  1621.         BIN      E b    GO TO    K g    OVER     SE n   TAB      E p
  1622.         BORDER   K b    IF       K u    PAPER    SE c   TAN      E e
  1623.         BRIGHT   SE b   IN       SE i   PAUSE    K m    THEN     S g
  1624.         CAT      SE 9   INK      SE x   PEEK     E o    TO       S f
  1625.         CHR$     E u    INKEY$   E n    PI       E m    USR      E l
  1626.         CIRCLE   SE h   INPUT    K i    PLOT     K q    VAL      E j
  1627.         CLEAR    K x    INT      E r    POINT    SE 8   VAL$     SE j
  1628.         CLOSE #  SE 5   INVERSE  SE m   POKE     K o    VERIFY   SE r
  1629.         CLS      K v    LEN      E k    PRINT    K p    <=       S q
  1630.         CODE     E i    LET      K l    RANDOMIZE K t   >=       S e
  1631.         CONTINUE K c    LIST     K k    READ     E a    <>       S w
  1632.         COPY     K z    LINE     SE 3   REM      K e
  1633.         COS      E w    LLIST    E v    RESTORE  E s    DEC      SE q
  1634.         DATA     E d    LN       E z    RETURN   K y    HEX      SE w
  1635.         DEF FN   SE 1   LOAD     K j    RND      E t
  1636.         DIM      K d    LPRINT   E c    RUN      K r
  1637.  
  1638.  
  1639.         Character  Spectrum kbrd   On PC keyboard
  1640.  
  1641.         &          S 6             ALT (or CTRL) 6
  1642.         '          S 7             ALT 7 or '/"
  1643.         (          S 8             ALT 8
  1644.         )          S 9             ALT 9
  1645.         _          S 0             ALT 0 or SHFT _/-
  1646.         <          S r             ALT r or SHFT </,
  1647.         >          S t             ALT t or SHFT >/,
  1648.         ;          S o             ALT o or :/;
  1649.         "          S p             ALT p or SHFT "/'
  1650.         ^          S h             ALT h
  1651.         -          S j             ALT j or _/-
  1652.         +          S k             ALT k or SHFT +/= or GREY +
  1653.         =          S l             ALT l or +/=
  1654.         :          S z             ALT z or SFHT :/;
  1655.         ?          S c             ALT c or SHFT ?//
  1656.         /          S v             ALT v or ?//
  1657.         *          S b             ALT b or GREY PRTSC/*
  1658.         ,          S n             ALT n or </,
  1659.         .          S m             ALT m or >/.
  1660.  
  1661.  
  1662.  
  1663. 4.2   The Interface I
  1664.  
  1665.     If you want to use the microdrive, you'll need cartridge files.  The
  1666.     emulator can create an empty cartridge file for you.  You have to format
  1667.     it before you can use it.  Type
  1668.  
  1669.         FORMAT "m";1;"name"
  1670.  
  1671.     to format the cartridge currently in Microdrive 1 giving it the name
  1672.     'name'.  Next, type CAT 1 to get a catalogue of the files on it (none of
  1673.     course) and the number of kilobytes free.  You can save a file by typing
  1674.     for instance
  1675.  
  1676.         SAVE *"m";1;"screen"SCREEN$
  1677.  
  1678.     Instead of SCREEN$ you can use all other expressions that are permitted
  1679.     also when saving to tape, like LINE nnnn or CODE x,y etcetera.  To load
  1680.     a file back from cartridge, you type (you guessed it)
  1681.  
  1682.         LOAD *"m";1;"screen"SCREEN$
  1683.  
  1684.     If the file doesn't exist or is of the wrong type you'll get the
  1685.     appropriate error message.  To erase a file, type for instance
  1686.  
  1687.         ERASE "m";1;"screen"
  1688.  
  1689.     Note that no * is needed (or even permitted), and that only the name
  1690.     should be given.  There's another way to create a file on a cartridge,
  1691.     and that is by using a command like OPEN #3;"m";1;"name", and printing
  1692.     to that stream.  You can use MOVE to move data from stream to stream,
  1693.     but I'll not go into that --- it's not very much used anyway.
  1694.  
  1695.     Instead of to the microdrive, you can also 'save to the RS232 link'. For
  1696.     instance, type SAVE *"b"SCREEN$ (note: there's no name!) to save a
  1697.     screen.  On the emulator you can send the output to the RS232 channel to
  1698.     a printer (then SAVE *"b" is useless), to a file (can be useful) or to
  1699.     the COM port (very useful if you connect a real Spectrum to the PC's COM
  1700.     port!).  You can load the data back by typing LOAD *"b"SCREEN$ and
  1701.     making sure the RS232 channel is fed with the right input (from a COM
  1702.     port or a file).  See also paragraph 2.6.
  1703.  
  1704.     If you want to use the RS232 channel for printing, open stream 3 for
  1705.     output to that channel by typing
  1706.  
  1707.         OPEN #3,"b"
  1708.  
  1709.     or
  1710.  
  1711.         OPEN #3,"t"
  1712.  
  1713.     The first will simply copy everything you send to stream 3 (using for
  1714.     instance LPRINT or LLIST) to the RS232 channel; the second converts CR's
  1715.     into CR/LF's, breaks off lines at 80 characters and translates keywords
  1716.     into character sequences.  "t" is useful for LLISTings, but not for
  1717.     anything else.
  1718.  
  1719.     Useful extra commands: CLS #, to clear the screen and reset the
  1720.     attributes to their reset defaults, and CLEAR # to do a CLS # and close
  1721.     all currently open streams (discarding all data that may still be
  1722.     buffered!)
  1723.  
  1724.     The Interface I uses its own system variables.  At the first error
  1725.     message you make (or RASP, or flashing question mark) and at the first
  1726.     Interface I statement you execute, it inserts them automatically.  Some
  1727.     programs will not run when the Interface I has inserted its system
  1728.     variables.  So if you load a game from tape, reset the Spectrum first
  1729.     and don't make an error typing LOAD "".  With a bit of exercise you
  1730.     should be able to do this.
  1731.  
  1732.  
  1733.  
  1734. 4.3  The Spectrum 128
  1735.  
  1736.     The main new features of the Spectrum 128 are its larger memory, that
  1737.     can be used as a Ram drive in Basic, and music capabilities.
  1738.  
  1739.     The Ram drive is accessed via the LOAD!, SAVE!, ERASE! and CAT!
  1740.     commands.  They work as you would expect.  Examples:
  1741.  
  1742.         SAVE !"name"SCREEN$
  1743.         CAT!
  1744.         LOAD !"name"SCREEN$
  1745.         ERASE !"name"
  1746.  
  1747.     The 3 channel sound chip of the Spectrum 128 can be used in Basic with
  1748.     the PLAY command.  Example:
  1749.  
  1750.         PLAY "cde","efg","gAB"
  1751.  
  1752.     plays three chords.  You can program complex effects, melodies and
  1753.     rhythms with the play command; they require many commands in the three
  1754.     voice strings which I won't explain...  They are explained in the
  1755.     Spectrum 128's user guide.
  1756.  
  1757.  
  1758.  
  1759.  
  1760. 5.  TECHNICAL INFORMATION
  1761.  
  1762.  
  1763. 5.1  The Spectrum
  1764.  
  1765.     The Spectrum is at the hardware level a very simple machine.  There's
  1766.     the 16K ROM which occupies the lowest part of the address space, and 48K
  1767.     of RAM which fills up the rest.  An ULA which reads the lowest 6912
  1768.     bytes of RAM to display the screen, and contains the logic for just one
  1769.     I/O port completes the machine, from a software point of view at least.
  1770.  
  1771.     Every even I/O address will address the ULA, but to avoid problems with
  1772.     other I/O devices only port FE should be used.  If this port is written
  1773.     to, bits have the following meaning:
  1774.  
  1775.  
  1776.         Bit   7   6   5   4   3   2   1   0
  1777.             ┌───┬───┬───┬───┬───┬───┬───┬───┐
  1778.             │   │   │   │ E │ M │   Border  │
  1779.             └───┴───┴───┴───┴───┴───┴───┴───┘
  1780.  
  1781.  
  1782.     The lowest three bits specify the border colour; a zero in bit 3
  1783.     activates the MIC output, and a one in bit 4 activates the EAR output
  1784.     (which sounds the internal speaker).  The real Spectrum also activates
  1785.     the MIC when the ear is written to; the emulator doesn't.  This is no
  1786.     problem; MIC is only used for saving, and when saving the Spectrum never
  1787.     sounds the internal speaker.  The upper three bits are unused.
  1788.  
  1789.     If port FE is read from, the highest eight address lines are important
  1790.     too.  A zero on one of these lines selects a particular half-row of five
  1791.     keys:
  1792.  
  1793.       IN:    Reads keys (bit 0 to bit 4 inclusive)
  1794.  
  1795.       #FEFE  SHIFT, Z, X, C, V            #EFFE  0, 9, 8, 7, 6
  1796.       #FDFE  A, S, D, F, G                #DFFE  P, O, I, U, Y
  1797.       #FBFE  Q, W, E, R, T                #BFFE  ENTER, L, K, J, H
  1798.       #F7FE  1, 2, 3, 4, 5                #7FFE  SPACE, SYM SHFT, M, N,
  1799.  
  1800.     A zero in one of the five lowest bits means that the corresponding key
  1801.     is being pressed.  If more than one address line is made low, the result
  1802.     is the logical AND of all single inputs, so a zero in a bit means that
  1803.     at least one of the appropriate keys is pressed.  For example, only if
  1804.     each of the five lowest bits of the result from reading from port 00FE
  1805.     (for instance by XOR A/IN A,(FE)) is one, no key is pressed.
  1806.  
  1807.     A final remark about the keyboard.  It is connected in a matrix-like
  1808.     fashion, with 8 rows of 5 columns, as is obvious from the above remarks.
  1809.     Any two keys pressed simultaneously can be uniquely decoded by reading
  1810.     from the IN ports, however, if more than two keys are pressed decoding
  1811.     may not be uniquely possible.  For instance, if you press Caps shift, B
  1812.     and V, the Spectrum will think also the Space key is pressed, and react
  1813.     by giving the 'Break into Program' report.  This matrix behaviour is
  1814.     also emulated - without it, Zynaps for instance won't pause when you
  1815.     press 5,6,7,8 and 0 simultaneously.
  1816.  
  1817.     Bit 5 (value 64) of IN-port FE is the ear input bit.  When the line is
  1818.     silent, its value is zero, except in the early Model 2 of the Spectrum,
  1819.     where it was one.  When there is a signal, this bit toggles.  The
  1820.     Spectrum loading software is not sensitive to the polarity of this bit
  1821.     (which it definitely should not be, not only because of this model
  1822.     difference, but also because you cannot be sure the tape recorder
  1823.     doesn't change the polarity of the signal recorded!) Some old programs
  1824.     rely on the fact that bit 5 is always one (for instance Spinads); for
  1825.     these programs the emulator can mimic a Model 2 Spectrum.
  1826.  
  1827.     Bits 6 and 7 are always one.
  1828.  
  1829.     The ULA with the lower 16K of RAM, and the processor with the upper 32K
  1830.     RAM and 16K ROM are working independently of each other.  The data and
  1831.     address buses of the Z80 and the ULA are connected by small resistors;
  1832.     normally, these do effectively decouple the buses.  However, if the Z80
  1833.     wants to read of write the lower 16K, the ULA halts the processor if it
  1834.     is busy reading, and after it's finished it lets the processor access
  1835.     lower memory through the resistors.  A very fast, cheap and neat design
  1836.     indeed!
  1837.  
  1838.     If you run a program in the lower 16K of RAM, or read or write in that
  1839.     memory, the processor is halted sometimes.  This part of memory is
  1840.     therefore somewhat slower than the upper 32K block.  This is also the
  1841.     reason that you cannot write a sound- or save-routine in lower memory;
  1842.     the timing won't be exact, and the music will sound harsh.  Also, INning
  1843.     from port FE will halt the processor, because the ULA has to supply the
  1844.     result.  Therefore, INning from port FE is a tiny bit slower on average
  1845.     than INning from other ports; whilst normally an IN A,(nn) instruction
  1846.     would take 11 T states, it takes 12.15 T states on average if nn=FE. See
  1847.     below for more exact information.
  1848.  
  1849.     If the processor reads from a non-existing IN port, for instance FF, the
  1850.     ULA won't stop, but nothing will put anything on the data bus.
  1851.     Therefore, you'll read a mixture of FF's (idle bus), and screen and ATTR
  1852.     data bytes (the latter being very scarce, by the way).  This will only
  1853.     happen when the ULA is reading the screen memory, about 60% of the
  1854.     1/50th second time slice in which a frame is generated.  The other 40%
  1855.     the ULA is building the border or generating a vertical retrace.  This
  1856.     behaviour is actually used in some program, for instance by Arkanoid,
  1857.     and the emulator also emulates this behaviour.
  1858.  
  1859.     Finally, there is an interesting bug in the ULA which also has to do
  1860.     with this split bus.  After each instruction fetch cycle of the
  1861.     processor, the processor puts the I-R register 'pair' (not the 8 bit
  1862.     internal Instruction Register, but the Interrupt and R registers) on the
  1863.     address bus.  The lowest 7 bits, the R register, are used for memory
  1864.     refresh.  However, the ULA gets confused if I is in the range 64-127,
  1865.     because it thinks the processor wants to read from lower 16K ram very,
  1866.     very often.  The ULA can't cope with this read-frequency, and regularly
  1867.     misses a screen byte.  Instead of the actual byte, the byte previously
  1868.     read is used to build up the video signal.  The screen seems to be
  1869.     filled with 'snow'; however, the Spectrum won't crash, and program will
  1870.     continue to run normally.  There's one program I know of that uses this
  1871.     to generate a nice effect: Vectron.  (which has very nice music too by
  1872.     the way).  This effect has not been implemented however - it's a bit
  1873.     useless (but maybe I'll include it in the future).
  1874.  
  1875.     The processor has three interrupt modes, selected by the instructions IM
  1876.     0, IM 1 and IM 2.  In mode 1, the processor simply executes a RST #38
  1877.     instruction if an interrupt is requested.  This is the mode the Spectrum
  1878.     is normally in.  The other mode that is commonly used is IM 2.  If an
  1879.     interrupt is requested, the processor first builds a 16 bit address by
  1880.     combining the I register (as the high byte) with whatever the
  1881.     interrupting device places on the data bus.  The word at this address is
  1882.     then called.  Rodnay Zaks in his book 'Programming the Z80' states that
  1883.     only even bytes are allowed as low index byte, but that isn't true.  The
  1884.     normal Spectrum contains no hardware to place a byte on the bus, and the
  1885.     bus will therefore always read FF (because the ULA also doesn't read the
  1886.     screen if it generates an interrupt), so the resulting index address is
  1887.     256*I+0FF.  However, some not-so-neat hardware devices put things on the
  1888.     data bus when they shouldn't, so later programs didn't assume the low
  1889.     index byte was 0FF.  These programs contain a 257 byte table of equal
  1890.     bytes starting at 256*I, and the interrupt routine is placed at an
  1891.     address that is a multiple of 257.  A useful but not so much used trick
  1892.     is to make the table contain FF's (or use the ROM for this) and put a
  1893.     byte 18 hex, the opcode for JR, at FFFF.  The first byte of the ROM is a
  1894.     DI, F3 hex, so the JR will jump to FFF4, where a long JP to the actual
  1895.     interrupt routine is put.
  1896.  
  1897.     In interrupt mode 0, the processor executes the instruction that the
  1898.     interrupting device places on the data bus.  On a standard Spectrum this
  1899.     will be the byte FF, coincidentally (...) the opcode for RST #38. But
  1900.     for the same reasons as above, this is not really reliable.
  1901.  
  1902.     The 50 Hz interrupt is synchronized with the video signal generation by
  1903.     the ULA; both the interrupt and the video signal are generated by it.
  1904.     Many programs use the interrupt to synchronize with the frame cycle.
  1905.     Some use it to generate fantastic effects, such as full-screen
  1906.     characters, full-screen horizon (Aquaplane) or pixel colour (Uridium for
  1907.     instance).  Very many modern programs use the fact that the screen is
  1908.     'written' (or 'fired') to the CRT in a finite time to do as much
  1909.     time-consuming screen calculations as possible without causing character
  1910.     flickering:  although the ULA has started displaying the screen for this
  1911.     frame already, the electron beam will for a moment not 'pass'
  1912.     this-or-that part of the screen so it's safe to change something there.
  1913.     So the exact time in the 1/50 second time-slice at which the screen is
  1914.     updated is very important.  Because the emulator updates the screen at
  1915.     once, no single best solution can be given, and therefore the user can
  1916.     select one of three possibilities (low, normal or high video
  1917.     synchronisation, corresponding to a screen update after 1/200, 2/200 or
  1918.     3/200 of a (relative) second after a Z80 interrupt) which gives the best
  1919.     results.  Try for instance Zynaps; with normal video synchronisation the
  1920.     top four or five lines of the background move out-of-phase with the
  1921.     rest, and your space-ship flickers in that region.  With low video
  1922.     synchronisation the background moves smoothly but the sprites flicker in
  1923.     all parts of the screen.  Only with high video sync everything moves
  1924.     smoothly and doesn't flicker.
  1925.  
  1926.     This emulator does not try to emulate the really time-critical border
  1927.     pattern effects (except when loading, but the width of the loading
  1928.     stripes are not quite right because also PC video timings come into
  1929.     play), but maybe I'll include it in the future.  I will need some hard
  1930.     data on video timings then, and I've figured these out recently.  Here
  1931.     they are.
  1932.  
  1933.     Each line takes exactly 224 T states.  After an interrupt occurs, 64
  1934.     line times pass before the byte 16384 is displayed.  At least the last
  1935.     48 of these are actual border-lines.  I could not determine whether my
  1936.     monitor didn't display the others or whether it was in vertical retrace,
  1937.     but luckily that's not really important.  Then the 192 screen+border
  1938.     lines are displayed, followed by about 56 border lines again.  56.5
  1939.     border lines would make up exactly 70000 T states, 1/50th of 3500000.
  1940.     However, I noticed that the frequency of the 50 Hz interrupt (measured
  1941.     in 1/T states!) changes very slightly when my Spectrum gets hot (I think
  1942.     it has something to do with the relative change of the frequencies of
  1943.     the two crystals in the Spectrum), so the time between interrupts will
  1944.     probably not be exactly 70000 T states. Anyway, whether the final border
  1945.     block is of fixed or variable length doesn't concern us either, the
  1946.     timings of the start and end of the screen, which are the timings of
  1947.     real interest, are fixed.
  1948.  
  1949.     Now for the timings of each line itself.  I define a screen line to
  1950.     start with 256 screen pixels, then border, then horizontal retrace, and
  1951.     then border again.  All this takes 224 T states.  Every half T state a
  1952.     pixel is written to the CRT, so if the ULA is reading bytes it does so
  1953.     each 4 T states (and then it reads two: a screen and an ATTR byte).  The
  1954.     border is 48 pixels wide at each side.  A video screen line is therefore
  1955.     timed as follows: 128 T states of screen, 24 T states of right border,
  1956.     48 T states of horizontal retrace and 24 T states of left border.
  1957.  
  1958.     When an interrupt occurs, the running instruction has to be completed
  1959.     first.  So the start of the interrupt is fixed relative to the start of
  1960.     the frame up to the length of the last instruction in T states.  If the
  1961.     processor was executing a HALT (which, according to the Z80 books I
  1962.     read, is effectively many NOPs), the interrupt routine starts at most 3
  1963.     T states away from the start of the frame.  Of course the processor also
  1964.     needs some T states to store the program counter on the stack, read the
  1965.     interrupt vector and jump to the routine, but since I cannot determine
  1966.     that by only using the Spectrum, it is useless information by that very
  1967.     reason alone!
  1968.  
  1969.     Now when to OUT to the border to change it at the place you want? First
  1970.     of all, you cannot change the border within a 'byte', an 8-pixel chunk.
  1971.     If we forget about the screen for a moment, if you OUT to port FE after
  1972.     14326 to 14329 T states (including the OUT) from the start of the IM 2
  1973.     interrupt routine, the border will change at exactly the position of
  1974.     byte 16384 of the screen.  The other positions can be computed by
  1975.     remembering that 8 pixels take 4 T states, and a line takes 224 T
  1976.     states.  You would think that OUTing after 14322 to 14325 T states, the
  1977.     border would change at 8 pixels left of the upper left corner of the
  1978.     screen.  This is right for 14322, 14323 and 14324 T states, but if you
  1979.     wait 14325 T states the ULA happens to be reading byte 16384 (or 22528,
  1980.     or both) and will halt the processor for a while, thereby making you
  1981.     miss the 8 pixels.  This exception happens again after 224 T states, and
  1982.     again after 448, an so forth.  These 192 exceptions left of the actual
  1983.     screen rectangle are the only ones; similar things don't happen at the
  1984.     right edge because the ULA don't need to read things there - it has just
  1985.     finished!
  1986.  
  1987.     As noted above, reading or writing in low ram (or OUTing to the ULA)
  1988.     causes the ULA to halt the processor.  When and how much? The processor
  1989.     is halted each time you want to access the ULA or low memory and the ULA
  1990.     is busy reading.  Of the 312.5 'lines' the ULA generates, only 192
  1991.     contain actual screen pixels, and the ULA will only read bytes during
  1992.     128 of the 224 T states of each screen line.  But if it does, the
  1993.     processor is halted for exactly 4 T states.
  1994.  
  1995.  
  1996.  
  1997. 5.2  The Interface I
  1998.  
  1999.     The Interface I is quite complicated.  It uses three different I/O
  2000.     ports, and contains logic to page and unpage an 8K ROM if new commands
  2001.     are used.  I won't be very detailed here; you could refer to the source
  2002.     code of the emulator if you want to know some details, or read the
  2003.     'Spectrum Shadow ROM Disassembly' by Gianlura Carri, published by
  2004.     Melbourne House - but don't expect the same level of detail as of Ian
  2005.     Logan and Frank O'Hara in their Rom disassembly book.
  2006.  
  2007.     The ROM is paged if the processor executes the instruction at ROM
  2008.     address 0008 or 1708 hexadecimal, the error and close# routines.  It is
  2009.     inactivated when the Z80 executes the RET at address 0700.
  2010.  
  2011.     I/O Port E7 is used to send or receive data to and from the microdrive.
  2012.     Accessing this port will halt the Z80 until the Interface I has
  2013.     collected 8 bits from the microdrive head; therefore, it the microdrive
  2014.     motor isn't running, or there is no formatted cartridge in the
  2015.     microdrive, the Spectrum hangs.  This is the famous 'IN 0 crash'.
  2016.  
  2017.     Port EF is used for several things:
  2018.  
  2019.  
  2020.        Bit    7   6    5    4    3    2    1     0
  2021.             ┌───┬───┬────┬────┬─────┬───┬─────┬─────┐
  2022.         READ│   │   │    │busy│ dtr │gap│ sync│write│
  2023.             │   │   │    │    │     │   │     │prot.│
  2024.             ├───┼───┼────┼────┼─────┼───┼─────┼─────┤
  2025.        WRITE│   │   │wait│ cts│erase│r/w│comms│comms│
  2026.             │   │   │    │    │     │   │ clk │ data│
  2027.             └───┴───┴────┴────┴─────┴───┴─────┴─────┘
  2028.  
  2029.  
  2030.     Bits DTR and CTS are used by the RS232 interface.  The WAIT bit is used
  2031.     by the Network to synchronise, GAP, SYNC, WR_PROT, ERASE, R/_W, COMMS
  2032.     CLK and COMMS DATA are used by the microdrive system.  If the microdrive
  2033.     is not being used, the COMMS DATA output selects the function of bit 0
  2034.     of out-port F7:
  2035.  
  2036.  
  2037.        Bit      7    6   5   4   3   2   1       0
  2038.             ┌──────┬───┬───┬───┬───┬───┬───┬───────────┐
  2039.         READ│txdata│   │   │   │   │   │   │    net    │
  2040.             │      │   │   │   │   │   │   │   input   │
  2041.             ├──────┼───┼───┼───┼───┼───┼───┼───────────┤
  2042.        WRITE│      │   │   │   │   │   │   │net output/│
  2043.             │      │   │   │   │   │   │   │   rxdata  │
  2044.             └──────┴───┴───┴───┴───┴───┴───┴───────────┘
  2045.  
  2046.  
  2047.     TXDATA and RXDATA are the input and output of the RS232 port.  COMMS
  2048.     DATA determines whether bit 0 of F7 is output for the RS232 or the
  2049.     network.
  2050.  
  2051.  
  2052.  
  2053. 5.3  The SamRam
  2054.  
  2055.     The SamRam contains a 32K static CMOS Ram chip, and some I/O logic for
  2056.     port 31.  If this port is read, it returns the position of the joystick,
  2057.     as a normal Kempston joystickinterface would.  If written to, the port
  2058.     controls a programmable latch chip (the 74LS259) which contains 8
  2059.     latches:
  2060.  
  2061.  
  2062.        Bit    7   6   5   4   3   2   1   0
  2063.             ┌───┬───┬───┬───┬───┬───┬───┬───┐
  2064.        WRITE│   │   │   │   │  address  │bit│
  2065.             └───┴───┴───┴───┴───┴───┴───┴───┘
  2066.  
  2067.  
  2068.     The address selects on of the eight latches; bit 0 is the new state of
  2069.     the latch.  The 16 different possibilities are collected in the diagram
  2070.     below:
  2071.  
  2072.         OUT 31,   │  Latch  │ Result
  2073.         ──────────┼─────────┼────────────────────────────────────────
  2074.             0     │    0    │ Switch on write protect of CMOS RAM
  2075.             1     │    "    │ Writes to CMOS RAM allowed
  2076.             2     │    1    │ turn on CMOS RAM (see also 6/7)
  2077.             3     │    "    │ turn off CMOS RAM (standard Spec.  ROM)
  2078.             4     │    2    │ -
  2079.             5     │    "    │ Ignore all OUT's to 31 hereafter
  2080.             6     │    3    │ Select CMOS bank 0 (Basic ROM)
  2081.             7     │    "    │ Select CMOS bank 1 (Monitor,...)
  2082.             8     │    4    │ Select interface 1
  2083.             9     │    "    │ Turn off IF 1 (IF1 rom won't be paged)
  2084.            10     │    5    │ Select 32K ram bank 0 (32768-65535)
  2085.            11     │    "    │ Select 32K ram bank 1 (32768-65535)
  2086.            12     │    6    │ Turn off beeper
  2087.            13     │    "    │ Turn on beeper
  2088.            14     │    7    │ -
  2089.            15     │    "    │ -
  2090.  
  2091.     At reset, all latches are 0.  If an OUT 31,5 is issued, only a reset
  2092.     will give you control over the latches again.  The write protect latch
  2093.     is not emulated; you're never able to write the emulated CMOS ram in the
  2094.     emulator.  Latch 4 will pull up the M1 output of the Z80.  The Interface
  2095.     I won't page the ROM anymore then.
  2096.  
  2097.  
  2098.  
  2099. 5.4  The Z80 microprocessor
  2100.  
  2101.     The Z80 processor is quite straightforward, and contains to my knowledge
  2102.     no interesting bugs or quirks.  However, it has some undocumented
  2103.     features.  Some of these are quite useful, and some are not, but since
  2104.     many programs use the useful ones, and a few programs use the weird
  2105.     ones, I tried to figure them out and emulate them as best as I could.
  2106.     There is a Z80 emulator around, intended as a CP/M emulator, which halts
  2107.     the program if an undocumented opcode is encountered.  I don't think
  2108.     this makes sense.  ZiLOG doesn't dictate the law, the programs which use
  2109.     the processor's features do!
  2110.  
  2111.     Most Z80 opcodes are one byte long, not counting a possible byte or word
  2112.     operand.  The four opcodes CB, DD, ED and FD are shift opcodes: they
  2113.     change the meaning of the opcode following them.
  2114.  
  2115.     There are 248 different CB opcodes.  The block CB 30 to CB 37 is missing
  2116.     from the official list.  These instructions, usually denoted by the
  2117.     mnemonic SLL, Shift Left Logical, shift left the operand and make bit 0
  2118.     always one.  Bounder and Enduro Racer use them.  The SamRam monitor can
  2119.     disassemble these and uses the mnemonic SLL.  These instructions are
  2120.     quite commonly used.
  2121.  
  2122.     The DD and FD opcodes precede instructions using the IX and IY
  2123.     registers.  If you look at the instructions carefully, you see how they
  2124.     work:
  2125.  
  2126.         2A nn           LD HL,(nn)
  2127.         DD 2A nn        LD IX,(nn)
  2128.         7E              LD A,(HL)
  2129.         DD 7E d         LD A,(IX+d)
  2130.  
  2131.     A DD opcode simply changes the meaning of HL in the next instruction.
  2132.     If a memory byte is addressed indirectly via HL, as in the second
  2133.     example, a displacement byte is added.  Otherwise the instruction simply
  2134.     acts on IX instead of HL.  (A notational awkwardness, that will only
  2135.     bother assembler and disassembler writers: JP (HL) is not indirect; it
  2136.     should have been denoted by JP HL) If a DD opcode precedes an
  2137.     instruction that doesn't use the HL register pair at all, the
  2138.     instruction is executed as usual.  However, if the instruction uses the
  2139.     H or L register, it will now use the high or low halves of the IX
  2140.     register! Example:
  2141.  
  2142.         44              LD B,H
  2143.         FD 44           LD B,IYh
  2144.  
  2145.     These types of inofficial instructions are used by very many programs.
  2146.     By the way, many DD or FD opcodes after each other will effectively be
  2147.     NOPs, doing nothing except repeatedly setting the flag 'treat HL as IX'
  2148.     (or IY) and taking up 4 T states.  (But try to let MONS disassemble such
  2149.     a block.)
  2150.  
  2151.     I've never seen a program using inofficial ED instructions, and except
  2152.     for ED 6B nn, a long version of 2A nn, LD HL,(nn) I don't know any.  I
  2153.     am pretty sure however that they exist, but I never took the trouble to
  2154.     test them all.
  2155.  
  2156.     About the R register.  This is not really an undocumented feature,
  2157.     although I have never seen any thorough description of it anywhere.  The
  2158.     R register is a counter that is updated every instruction, where DD, FD,
  2159.     ED and CB are to be regarded as separate instructions.  So shifted
  2160.     instruction will increase R by two.  There's an interesting exception:
  2161.     doubly-shifted opcodes, the DDCB and FDCB ones, increase R by two too.
  2162.     LDI increases R by two, LDIR increases it by 2 times BC, as does LDDR
  2163.     etcetera.  The sequence LD R,A / LD A,R increases A by two, except for
  2164.     the highest bit: this bit of the R register is never changed.  This is
  2165.     because in the old days everyone used 16 Kbit chips.  Inside the chip
  2166.     the bits where grouped in a 128x128 matrix, needing a 7 bit refresh
  2167.     cycle.  Therefore ZiLOG decided to count only the lowest 7 bits. Anyway,
  2168.     if the R register emulation is switched on the R register will behave as
  2169.     is does on a real Spectrum; if it is off it will (except for the upper
  2170.     bit) act as a random generator.
  2171.  
  2172.     You can easily check that the R register is really crucial to memory
  2173.     refresh.  Assemble this program:
  2174.  
  2175.         ORG 32768
  2176.         DI
  2177.         LD B,0
  2178.     L1  XOR A
  2179.         LD R,A
  2180.         DEC HL
  2181.         LD A,H
  2182.         OR L
  2183.         JR NZ,L1
  2184.         DJNZ L1
  2185.         EI
  2186.         RET
  2187.  
  2188.     It will take about three minutes to run.  Look at the upper 32K of
  2189.     memory, for instance the UDG graphics.  It will have faded.  Only the
  2190.     first few bytes of each 256 byte block will still contain zeros, because
  2191.     they were refreshed during the execution of the loop.  The ULA took care
  2192.     of the refreshing of the lower 16K.  (This example won't work on the
  2193.     emulator of course!)
  2194.  
  2195.     Then there's one other dark corner of the Z80 which has its effect on
  2196.     programs like Sabre Wulf, Ghosts'n Goblins and Speedlock.  The Mystery
  2197.     of the Undocumented Flags!
  2198.  
  2199.     Bit 3 and 5 of the F register are not used.  They can contain
  2200.     information, as you can readily figure out by using PUSH AF and POP AF.
  2201.     Furthermore, sometimes their values change.  I found the following
  2202.     empirical rule:
  2203.  
  2204.         The values of bit 7, 5 and 3 follow the values of the
  2205.         corresponding bits of the last 8 bit result of an instruction
  2206.         that changed the usual flags.
  2207.  
  2208.     For instance, after an ADD A,B those bits will be identical to the bits
  2209.     of the A register.  (Bit 7 of F is the sign flag, and fits the rule
  2210.     exactly).  An exception is the CP x instruction (x=register, (HL) or
  2211.     direct argument).  In that case the bits are copied from the argument.
  2212.  
  2213.     If the instruction is one that operates on a 16 bit word, the 8 bits of
  2214.     the rule are the highest 8 bits of the 16 bit result - that was to be
  2215.     expected since the S flag is extracted from bit 15.
  2216.  
  2217.     Ghosts'n Goblins use the undocumented flag due to a programming error.
  2218.     The rhino in Sabre Wulf walks backward or keeps running in little
  2219.     circles in a corner, if the (in this case undocumented) behaviour of the
  2220.     sign flag in the BIT instruction isn't right.  I quote:
  2221.  
  2222.         AD86    DD CB 06 7E        BIT 7,(IX+6)
  2223.         AD89    F2 8F AD           JP P,#AD8F
  2224.  
  2225.     An amazing piece of code! Speedlock does so many weird things that all
  2226.     must be exactly right for it to run.  Finally, the '128 rom uses the AF
  2227.     register to hold the return address of a subroutine for a while.  To
  2228.     keep all programs happy, and still have a fast emulator, I had to make a
  2229.     compromise.  The undocumented flags are not always emulated right, but
  2230.     they are most of the time.
  2231.  
  2232.     Finally, a remark about the interrupt flip flops IFF1 and IFF2.  There
  2233.     seems to be a little confusion about these.  These flip flops are
  2234.     simultaneously set or reset by the EI and DI instructions.  IFF1
  2235.     determines whether interrupts are allowed, but its value cannot be read.
  2236.     The value of IFF2 is copied to the P/V flag by LD A,I and LD A,R.  When
  2237.     an NMI occurs, IFF1 is reset, thereby disallowing further (maskable)
  2238.     interrupts, but IFF2 is left unchanged.  This enables the NMI service
  2239.     routine to check whether the interrupted program had enabled or disabled
  2240.     maskable interrupts.  So, Spectrum snapshot software can only read IFF2,
  2241.     but most emulators will emulate both, and then the one that matters most
  2242.     is IFF1.
  2243.  
  2244.     Now for the emulated Z80.  I have added eight instructions, to speed up
  2245.     the RS232 input and output of the Interface I and several things of the
  2246.     SamRam.  These opcodes, ED F8 to ED FE are of little use to any other
  2247.     program.  ED FF is a nice one: it returns you to DOS immediately.  I
  2248.     used it for debugging purposes.
  2249.  
  2250.  
  2251.  
  2252. 5.5  File formats
  2253.  
  2254.     This sections describes the formats of the files used by the emulator.
  2255.  
  2256.  
  2257.     ROMS.BIN:
  2258.     ---------
  2259.  
  2260.         00000-03fff     Ordinary Spectrum rom
  2261.         04000-05fff     Interface I rom (8K)
  2262.         06000-09fff     First SamRam rom (contains BASIC)
  2263.         0a000-0dfff     Second SamRam rom (contains monitor,...)
  2264.         0e000-11fff     First Spectrum 128K rom (active at RESET)
  2265.         12000-15fff     Second Spectrum 128K rom (contains BASIC)
  2266.  
  2267.     The ordinary rom has not been modified.  The Interface I rom has
  2268.     undergone some modifications, to speed up the RS232 input/output
  2269.     routines.  If you don't like this, or want to use another version of the
  2270.     Interface I, you could put that code at the right place in the ROMS.BIN
  2271.     file.  The interface I should work properly, although the RS232 will be
  2272.     slower (always FORMAT the "b" or "t" channel at 19200 baud, by the way,
  2273.     if you replace the rom code, there's no point in waiting for nothing!)
  2274.     The microdrive routines have not been modified in any way.  Here are the
  2275.     changes of the Interface I rom:
  2276.  
  2277.         Address: Old: New:           Address: Old: New:
  2278.  
  2279.         0B9E     ED   ED             0D20     FB   00
  2280.         0B9F     5B   FC             0D2A     37   ED
  2281.         0BA0     C3   F5             0D2B     F3   FD
  2282.         0BA1     5C   C3             0D2C     CE   18
  2283.         0BA2     21   34             0D2D     00   10
  2284.         0BA3     20   0C             0D4C     FB   00
  2285.  
  2286.     These changes are not likely to cause problems; there are several
  2287.     versions of the Interface I rom around, and program developers know
  2288.     this.  It is also a bit pointless to check whether the Interface I rom
  2289.     hasn't been modified; who would put his snapshot software in there
  2290.     anyway, and that's what those people are afraid of.
  2291.  
  2292.     The first and second SamRam rom have been modified more extensively. The
  2293.     biggest problem was that switching the upper 32K ram bank is very fast
  2294.     in reality, but on the PC two blocks of 32K bytes had to be REP
  2295.     MOVSWded.  But since no programs know of the SamRam code anyway, this
  2296.     won't cause any more problems it wouldn't already cause either.
  2297.  
  2298.     The two Spectrum 128 roms have not been modified.
  2299.  
  2300.  
  2301.     .TAP FILES:
  2302.     -----------
  2303.  
  2304.     The .TAP files contain blocks of tape-saved data.  All blocks start with
  2305.     two bytes specifying how many bytes will follow (not counting the two
  2306.     length bytes).  Then raw tape data follows, including the flag and
  2307.     checksum bytes.  The checksum is the bitwise XOR of all bytes including
  2308.     the flag byte.  For example, when you execute the line SAVE "ROM" CODE
  2309.     0,2 this will result:
  2310.  
  2311.  
  2312.              |------ Spectrum-generated data -------|       |---------|
  2313.        13 00 00 03 52 4f 4d 7x20 02 00 00 00 00 80 f1 04 00 ff f3 af a3
  2314.  
  2315.        ^^^^^       first block is 19 bytes (17 bytes+flag+checksum)
  2316.              ^^    flag byte (A reg, 00 for headers, ff for datablocks)
  2317.                 ^^ first byte of header, indicating a code block
  2318.  
  2319.        filename    ^^^^^^^^^^^^^
  2320.        header info               ^^^^^^^^^^^^^^^^^
  2321.        checksum of header                          ^^
  2322.        length of second block                         ^^^^^
  2323.        flag byte                                             ^^
  2324.        first two bytes of rom                                  ^^^^^
  2325.        checksum (checkbittoggle would be better)                     ^^
  2326.  
  2327.  
  2328.     The emulator will always start reading bytes at the beginning of a
  2329.     block.  If less bytes are loaded than are available, the other bytes are
  2330.     skipped, and the last byte loaded is used as checksum.  If more bytes
  2331.     are asked for than exist in the block, the loading routine will
  2332.     terminate with the usual tape-loading-error flags set, leaving the error
  2333.     handling to the calling Z80 program.
  2334.  
  2335.     Note that it is possible to join .TAP files by simply stringing them
  2336.     together, for example COPY /B FILE1.TAP + FILE2.TAP ALL.TAP
  2337.  
  2338.     For completeness, I'll include the structure of a tape header.  A header
  2339.     always consists of 17 bytes:
  2340.  
  2341.         Byte    Length  Description
  2342.         0       1       Type (0,1,2 or 3)
  2343.         1       10      Filename (padded with blanks)
  2344.         11      2       Length of data block
  2345.         13      2       Parameter 1
  2346.         15      2       Parameter 2
  2347.  
  2348.     The type is 0,1,2 or 3 for a Program, Number array, Character array or
  2349.     Code file.  A screen$ file is regarded as a Code file with start address
  2350.     16384 and length 6912 decimal.  If the file is a Program file, parameter
  2351.     1 holds the autostart line number (or a number >=32768 if no LINE
  2352.     parameter was given) and parameter 2 holds the start of the variable
  2353.     area relative to the start of the program.  If it's a Code file,
  2354.     parameter 1 holds the start of the code block when saved, and parameter
  2355.     2 holds 32768.  For data files finally, the byte at position 14 decimal
  2356.     holds the variable name.
  2357.  
  2358.  
  2359.     .MDR FILES:
  2360.     -----------
  2361.  
  2362.     The emulator uses a cartridge file format identical to the 'Microdrive
  2363.     File' format of Carlo Delhez' Spectrum emulator Spectator for the QL.
  2364.     The following information is adapted from Carlo's documentation.  It can
  2365.     also be found in the 'Spectrum Microdrive Book', by Ian Logan (co-writer
  2366.     of the excellent 'Complete Spectrum ROM Disassembly').
  2367.  
  2368.     A cartridge file contains 254 'sectors' of 543 bytes each, and a final
  2369.     byte flag which is non-zero is the cartridge is write protected, so the
  2370.     total length is 137923 bytes.  On the cartridge tape, after a GAP of
  2371.     some time the Interface I writes 10 zeros and 2 FF bytes (the preamble),
  2372.     and then a fifteen byte header-block-with-checksum.  After another GAP,
  2373.     it writes a preamble again, with a 15-byte record-
  2374.     descriptor-with-checksum (which has a structure very much like the
  2375.     header block), immediately followed by the data block of 512 bytes, and
  2376.     a final checksum of those 512 bytes.  The preamble is used by the
  2377.     Interface I hardware to synchronise, and is not explicitly used by the
  2378.     software.  The preamble is not saved to the microdrive file:
  2379.  
  2380.     offset length name    contents
  2381.  
  2382.       0      1   HDFLAG   Value 1, to indicate header block
  2383.       1      1   HDNUMB   sector number (values 254 down to 1)
  2384.       2      2            not used
  2385.       4     10   HDNAME   microdrive cartridge name (blank padded)
  2386.      14      1   HDCHK    header checksum (of first 14 bytes)
  2387.  
  2388.      15      1   RECFLG   - bit 0: always 0 to indicate record block
  2389.                           - bit 1: set for the EOF block
  2390.                           - bit 2: reset for a PRINT file
  2391.                           - bits 3-7: not used (value 0)
  2392.      16      1   RECNUM   data block sequence number (value starts at 0)
  2393.      17      2   RECLEN   data block length (<=512, LSB first)
  2394.      19     10   RECNAM   filename (blank padded)
  2395.      29      1   DESCHK   record descriptor checksum (of previous 14 bytes)
  2396.      30    512            data block
  2397.     542      1   DCHK     data block checksum (of all 512 bytes of data
  2398.                            block, even when not all bytes are used)
  2399.     ---------
  2400.     254 times
  2401.  
  2402.  
  2403.     (Actually, this information is 'transparent' to the emulator.  All it
  2404.     does is store 2 times 254 blocks in the .MDR file as it is OUTed,
  2405.     alternatingly of length 15 and 528 bytes.  The emulator does check
  2406.     checksums, see below; the other fields are dealt with by the emulated
  2407.     Interface I software.)
  2408.  
  2409.     A used record block is either an EOF block (bit 1 of RECFLG is 1) or
  2410.     contains 512 bytes of data (RECLEN=512, i.e.  bit 1 of MSB is 1).  An
  2411.     empty record block has a zero in bit 1 of RECFLG and also RECLEN=0.  An
  2412.     unusable block (as determined by the FORMAT command) is an EOF block
  2413.     with RECLEN=0.
  2414.  
  2415.     The three checksums are calculated by adding all the bytes together
  2416.     modulo 255; this will never produce a checksum of 255.  Possibly, this
  2417.     is the value that is read by the Interface I if there's no or bad data
  2418.     on the tape.
  2419.  
  2420.     In normal operation, all first-fifteen-byte blocks of each header or
  2421.     record block will have the right checksum.  If the checksum is not
  2422.     right, the block will be treated as a GAP.  For instance, if you type
  2423.     OUT 239,0 on a normal Spectrum with interface I, the microdrive motor
  2424.     starts running and the cartridge will be erased completely in 7 seconds.
  2425.     CAT 1 will respond with 'microdrive not ready'.  Try it on the
  2426.     emulator...
  2427.  
  2428.  
  2429.     .SCR FILES:
  2430.     -----------
  2431.  
  2432.     .SCR files are memory dumps of the first 6912 bytes of the Spectrum
  2433.     memory.  A coordinate (x,y), x between 0 and 255 and y between 0 and
  2434.     192, (0,0) being the upper left corner of the screen, corresponds to the
  2435.     pixel address
  2436.  
  2437.         16384+INT (x/8)+1792*INT (y/64)-2016*INT (y/8)+256*y
  2438.  
  2439.     The lowest three bits of x determine which bit of this address
  2440.     corresponds to the pixel (x,y).  This bit-map constitutes the larger
  2441.     part of the screen memory, 256*192/8=6144 bytes.  The final 768 bytes
  2442.     are attribute bytes.  The address of the attribute byte corresponding to
  2443.     pixel (x,y) is
  2444.  
  2445.         22528+INT (x/8)+32*INT (y/8)
  2446.  
  2447.     The lowest three bits of the attribute byte control the foreground color
  2448.     (the color of the pixel if the corresponding bit is set), bits 3-5
  2449.     control the background color, bit 6 is the bright bit and bit 7 is the
  2450.     flash bit.
  2451.  
  2452.  
  2453.  
  2454.     .Z80 FILES:
  2455.     -----------
  2456.  
  2457.     The old .Z80 snapshot format (for version 1.45 and below) looks like
  2458.     this:
  2459.  
  2460.         Byte    Length  Description
  2461.         0       1       A register
  2462.         1       1       F register
  2463.         2       2       BC register pair (LSB, i.e.  C, first)
  2464.         4       2       HL register pair
  2465.         6       2       Program counter
  2466.         8       2       Stack pointer
  2467.         10      1       Interrupt register
  2468.         11      1       Refresh register (Bit 7 is not significant!)
  2469.         12      1       Bit 0  : Bit 7 of the R-register
  2470.                         Bit 1-3: Border colour
  2471.                         Bit 4  : 1=Basic SamRom switched in
  2472.                         Bit 5  : 1=Block of data is compressed
  2473.                         Bit 6-7: No meaning
  2474.         13      2       DE register pair
  2475.         15      2       BC' register pair
  2476.         17      2       DE' register pair
  2477.         19      2       HL' register pair
  2478.         21      1       A' register
  2479.         22      1       F' register
  2480.         23      2       IY register (Again LSB first)
  2481.         25      2       IX register
  2482.         27      1       Interrupt flipflop, 0=DI, otherwise EI
  2483.         28      1       IFF2 (not particularly important...)
  2484.         29      1       Bit 0-1: Interrupt mode (0, 1 or 2)
  2485.                         Bit 2  : 1=Issue 2 emulation
  2486.                         Bit 3  : 1=Double interrupt frequency
  2487.                         Bit 4-5: 1=High video synchronisation
  2488.                                  3=Low video synchronisation
  2489.                                  0,2=Normal
  2490.                         Bit 6-7: 0=Cursor/Protek/AGF joystick
  2491.                                  1=Kempston joystick
  2492.                                  2=Sinclair 1 joystick
  2493.                                  3=Sinclair 2 joystick
  2494.  
  2495.     Because of compatibility, if byte 12 is 255, it has to be regarded as
  2496.     being 1.  After this header block of 30 bytes the 48K bytes of Spectrum
  2497.     memory follows in a compressed format (if bit 5 of byte 12 is one). The
  2498.     compression method is very simple: it replaces repetitions of at least
  2499.     five equal bytes by a four-byte code ED ED xx yy, which stands for "byte
  2500.     yy repeated xx times".  Only sequences of length at least 5 are coded.
  2501.     The exception is sequences consisting of ED's; if they are encountered,
  2502.     even two ED's are encoded into ED ED 02 ED.  Finally, every byte
  2503.     directly following a single ED is not taken into a block, for example
  2504.     ED 6*00 is not encoded into ED ED ED 06 00 but into ED 00 ED ED 05 00.
  2505.     The block is terminated by an end marker, 00 ED ED 00.
  2506.  
  2507.     That's the format of .Z80 files as used by versions up to 1.45.  Since
  2508.     version 2.0 emulates the Spectrum 128 too, there was a need for a new
  2509.     format.
  2510.  
  2511.     The first 30 bytes are almost the same as the old versions' header.  Of
  2512.     the flag byte, bit 4 and 5 have got no meaning anymore, and the program
  2513.     counter (bytes 6 and 7) are zero to signal a version 2.0 .Z80 file.  So
  2514.     loading a new style .Z80 file into an old emulator will cause an error
  2515.     or a reset at the most.
  2516.  
  2517.     After the first 30 bytes, an additional header follows:
  2518.  
  2519.         Byte    Length  Description
  2520.         30      2       Length of additional header block (contains 23)
  2521.         32      2       Program counter
  2522.         34      1       Hardware mode: 0=Spectrum 48K, 1=0+interface I,
  2523.                         2=SamRam, 3=Spectrum 128K, 4=3+interface I.
  2524.         35      1       If in SamRam mode, bitwise state of 74ls259.
  2525.                         For example, bit 6=1 after an OUT 31,13 (=2*6+1)
  2526.                         If in 128 mode, contains last OUT to 7ffd
  2527.         36      1       Contains 0FF if Interface I rom paged
  2528.         37      1       Bit 0: 1 if R register emulation on
  2529.                         Bit 1: 1 if LDIR emulation on
  2530.         38      1       Last OUT to fffd (soundchip register number)
  2531.         39      16      Contents of the sound chip registers
  2532.  
  2533.     Hereafter a number of memory blocks follow, each containing the
  2534.     compressed data of a 16K block.  The compression is according to the old
  2535.     scheme, except for the end-marker, which is now absent.  The structure
  2536.     of a memory block is:
  2537.  
  2538.         Byte    Length  Description
  2539.         0       2       Length of data (without this 3-byte header)
  2540.         2       1       Page number of block
  2541.         3       [0]     Compressed data
  2542.  
  2543.     The pages are numbered, depending on the hardware mode, in the following
  2544.     way:
  2545.  
  2546.         Page    In '48 mode     In '128 mode    In SamRam mode
  2547.  
  2548.          0      48K rom         rom (basic)     48K rom
  2549.          1      Interf. I rom   Interf. I rom   Interf. I rom
  2550.          2      -               rom (reset)     samram rom (basic)
  2551.          3      -               page 0          samram rom (monitor,..)
  2552.          4      8000-bfff       page 1          Normal 8000-bfff
  2553.          5      c000-ffff       page 2          Normal c000-ffff
  2554.          6      -               page 3          Shadow 8000-bfff
  2555.          7      -               page 4          Shadow c000-ffff
  2556.          8      4000-7fff       page 5          4000-7fff
  2557.          9      -               page 6          -
  2558.         10      -               page 7          -
  2559.  
  2560.     In 48K mode, pages 4,5 and 8 are saved.  In SamRam mode, pages 4 to 8
  2561.     are saved.  In 128 mode, all pages from 3 to 10 are saved.  This
  2562.     version saves the pages in numerical order.  There is no end marker.
  2563.  
  2564.  
  2565.