--------------------------------------------------------------------------------
IBM RT Emulator
Copyright (C) 1998-2020 Kris Bleakley
email: kindred@crazysmart.net.au
--------------------------------------------------------------------------------

Last updated 25th October 2020

Table of Contents

i.  Disclaimer
1.  Introduction
2.  System Requirements
3.  Getting Started
4.  Configuration (config.ini)
    4.1  System BIOS
    4.2  Video Display Adapter
         4.2.1  Monochrome Display Adapter
5.  LED Display Codes
6.  Missing Features


/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\

i. Disclaimer (Please read before operating software)

This product is provided free of charge and therefore on an "AS IS" basis,
without warranty of any kind, express or implied, including without limitation
the warranties that it is free of defects, virus free, able to operate on an
uninterrupted basis, merchantable, fit for a particular purpose or
non-infringing. This Disclaimer of warranty constitutes an essential part of
this agreement. No use of the product is authorised hereunder except under this
disclaimer. This product is for non-commercial use only and shall not be
packaged with any commercially licensed product or software.


/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\

1. Introduction

The IBM RT emulation core was introduced in January 2020 and is very much a work
in progress. Currently the emulation will stall during the boot process.


/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\

2. System Requirements

It is recommended that you limit the number of programs running in the background
as this software uses a lot of CPU time while running.

Minimum System Required

* Intel Quad Core 2.4GHz or equivalent processor
* 256MB Available System Memory
* 1GB Available HDD space
* Microsoft Compatible Mouse and Keyboard
* Microsoft Windows 7
* Microsoft Direct-X 8


/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\

3. Getting Started

Two BIOS files are required to emulate the system.

What is a BIOS file?

BIOS is an acronym for Basic Input/Output System. This is a piece of software
(written by the manufacturer of the computer) stored in Read Only Memory (ROM).
The purpose of the BIOS is to initialize (test) the hardware and ready the
computer for transfer to a Disk Operating System (DOS).

The two BIOS files required are the system BIOS (located on the main board)
and the video BIOS (located on a video card attached to the main board).

Note: Due to copyright these files are not provided with this software.
      A suitable BIOS may be located with the help of an internet search engine.

Note: Make sure the video BIOS matches the specified video standard.
      An incorrect video BIOS will produce undesired results and may cause the
      emulated system to stall or report Power On Self Test (POST) errors.

Emulation is started by selecting "start" from the system menu, followed by
"IBM RT-PC".

The IBM RT was fitted with an LED front panel which was used to display Power On
Self Test (POST) codes, see "LED Display Codes" for more information. If the
processor has stalled, the code will indicate which component has failed POST.


/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\

4. Configuration (config.ini)

The "system" section should contain the variable "profile". This variable is
used to specify which section will be used to configure the IBM RT.

Example:

[system]
profile=IBM6150

Note: While an infinite number of configurations may be defined in config.ini,
      only one is selectable for use (at this time).

4.1 System BIOS (ROM required)

As mentioned in "Getting Started", the system will not function without a BIOS.
The "bios_rom" variable is used to specify the location of the BIOS file.

Example:

[IBM6150]
bios_rom=rtpc\ibm6100.bin

4.2 Video Display Adapter

The IBM RT emulation is hardwired to use the IBM Monochrome Display Adapter.
Other cards were available for use with the system but are not yet supported.

4.2.1 Monochrome Display Adapter (ROM required)

The IBM Monochrome Display Adapter (MDA) was the first video adapter developed
for the IBM PC. The adapter was only capable of displaying text. Characters were
generated from ROM which stored an 8x8 and 8x16 character set.

The "rom" variable under the "IBM_MDA" section is used to specify the location
of the character ROM.

Example:

[IBM_MDA]
rom=ibm\char.bin


Note: The above information is a work in progress and is subject to change in
      future releases as more options are made available.

/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\

5. LED Display Codes

The following is a list of the IPL ROM display codes.

00 - Initializing PC Mono adapter
0c - Initializing PC Mono adapter (Advanced Processor)
01 - ROM CRC error
1c - ROM CRC error (Advanced Processor)
02 - Error testing for soft IPL
03 - Memory test- 1st 128K-bytes
3c - Memory test- 1st 128K-bytes (Advanced Processor)
04 - Processor board bad
4c - Advanced Processor board bad
05 - Processor board or memory bad
5c - Advanced Processor board or memory bad
07 - IOCC test
7c - IOCC test (Advanced Processor)
08 - Processor board failed in IOCC test
8c - Advanced Processor board failed in IOCC test
09 - Keyboard adapter
10 - System timer (RTC)
11 - Interrupt controller test
12 - DMA test
13 - Serial ports
14 - Fixed Disk and Diskette Adapter Board 1
15 - Fixed Disk and Diskette Adapter Board 2
16 - Fixed Disk and Diskette Adapter Board 1
17 - Fixed Disk and Diskette Adapter Board 2
18 - Expansion ROM in control
19 - Manufacturing IPL
20 - NVRAM CRC
21 - NVRAM order IPL
22 - ROM default order IPL
23 - No IPL device found
25 - Soft IPL check failure condition
26 - Attempting soft IPL
27 - Bootable code won't fit in available RAM
29 - Loadable code has been started
88 - Machine check stop
89 - Unexpected program check or machine check
96 - Memory board in slot C bad
97 - Memory board in slot D bad
98 - Both memory boards bad
99 - Keylock locked


/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\

6. Missing Features

Here is a list of some the features that are not yet implemented in this version
but I will endevour to add them some time in the not so distant future. This
list will most likely become larger over time.

* Keyboard and Locator support
* Megapel Adapter

