Setting up the HSGPL for MAME

The following descriptions refer to MESS releases 0.146 and higher.

Please respect the copyright of the SNUG. Usage of the ROMs is only allowed for owners of a real HSGPL card.

Introduction

The HSGPL is a peripheral expansion expansion card created by the System-99 User Group (SNUG). It contains Flash ROM circuits and RAM circuits, so parts of its memory are persistent. The HSGPL is able to simulate 16 individual cartridges. They can be switched by the console-internal cartridge selection. The intended use is to dump a plugged-in cartridge on disk, and then to upload the data into one of the 16 banks.

In addition, the HSGPL replaces the GROMs in the console. When the card is plugged in, the console GROMs should be removed, or the card will not offer its complete functionality.

This also means that a completely blank HSGPL will not work. In that case, the TI system will immediately lock up with a black screen when turned on. The minimum contents of an HSGPL is a basic DSR and the console GROM contents. Each real HSGPL card is delivered with this minimum content.

The HSGPL emulation

In the TI part of the MESS emulator, the HSGPL card is emulated with the implementation to be found in machine/ti99/hsgpl.c. The complete circuitry is emulated by following the functional description (instead of utilizing the schematics and printed board layout). Since MESS does not provide ROM contents due to copyright restrictions, you have to get an own copy of the HSGPL DSR and initial memory contents. If you own an HSGPL you can dump the contents with your real TI and transfer them to the MESS TI emulation. Otherwise you should get in contact with the SNUG people and request a copy of the DSR.

To use the HSGPL you have to plug it into a slot of the Peripheral Expansion Box:

mess ti99_4a -peb:slot3 hsgpl ...

Once more, keep in mind:

If you activate the HSGPL extension without the initial ROM contents, the emulation will lock up.

This is not an emulation glitch - it is exactly what will happen with the real device.

With the real hardware, you do not have to care about the initial setup. Moreover, you actually cannot set up the card in-system; the flash ROMs have to be burnt separately. After this initial procedure, you can certainly modify all contents (and, of course, render it unusable if you are careless enough).

In MESS we slightly modify the HSGPL to allow for in-system flashing. We add a DIP switch in the MESS Dip switches menu:

HSGPL mode: Flash

After you left the on-screen menu, press F3 to reset the system, and the TI should start up. The effect of this switch is that you can now actually access the card, but only in a region that does not hide the system GROMs. This suffices to flash the card.

Once you have uploaded the initial system you must reset this switch to Normal in order to properly use the card.

Setting up Step-By-Step

In the following I will guide you through the setup process, picking you up with a completely blank HSGPL, and dropping you off with a completely working device.

Flashing the DSR on the card

The first thing to do is to install a DSR on the card. On the SNUG Website you will find a tool called DSRLDR3. This is a tool to burn contents onto a flash ROM. Also, you will find on that website the HSGPL ROM packages, one for 40 column, one for 80 column setups. For the standard TI (without EVPC) we will get the 40 column version. You need the "complete package". Make sure that you eventually have 8 files named HSGPL*.P99.

The DSRLDR3 program is stored in TIFILES format, as are the ROMs in the DSR zip file. You have to import these files into a disk image before using them in the emulation.

Supposed you have all eight files and the DSRLDR3 on your disk image, you proceed as follows:

• Launch the MESS emulator

mess ti99_4a -peb:slot3 hsgpl -peb:slot8 hfdc -flop1 mysetup.dsk -cart editor_assembler.rpk

You can also start the emulator on the command line without these arguments, or with a front-end like QMC2. Do not forget to insert the cards and media as written above.

• Load the DSRLDR3 program option 5

* RUN PROGRAM FILE * 

FILE NAME?
DSK1.DSRLDR3

When the program starts you have a black screen with cyan-colored text on it. At first you have to set the file name of the DSR files to be burnt onto the card. Type F for Filename and enter the name of the first DSR file on your disk. My files are named HSGPLDS0 to HSGPLDS7, so I enter

File: DSK1.HSGPLDS0

Next, type L for Load. You will get a warning

Caution! Really programming? Confirm with "Y"

Confirm the dialog. If everything goes well you should observe all files being burned on the card, increasing the number of the file and the target location. If you get a warning message

FlashID not recognized

you should remove the old contents of the HSGPL by deleting the hsgpl files. They can be found in the nvram folder that was automatically created, and there in the system subdirectory (here: hsgpl/ti99_4a).

Finally, a message should appear:

All Files loaded correctly (Any Key)

which proves that all files have been loaded correctly. You can now leave the DSRLDR3 program with QUIT or FCTN-9.

Wait ... keep the configuration switch set to "Flash" - you are not done yet.

Installing the console GROM content

If you now prematurely switch the HSGPL to on, you will still get a black screen when you restart the emulation. This is correct, as your HSGPL still has no content in the GROM positions. The data you have just burnt are in a backup area of the card. We will now copy these data to the proper locations.

This must be done with a small assembler program. I wrote such a program that you have to assemble before using.

Type in the source code, assemble using Editor/Assembler, and the run the program via option 3.

* LOAD AND RUN *

FILE NAME?
DSK1.HGPLNEW_O

The program will autostart, and after some seconds return to the Master Title Screen. Now you should now open the MESS menu and change the switch to

HSGPL mode: Normal

We now have to unplug the GROMs in the console. Also in the MESS menu, go to the System Configuration menu and select

Console GROMs: Off

In the MESS menu, go to File manager and unplug the Editor/Assembler cartridge. You will find an entry at the very top of the selection list called [empty slot]. Alternatively, terminate the emulation and restart without the cartridge.

If you are still in the emulation, exit the menu and reset the console with F3. Otherwise, restart the emulation

mess ti99_4a -peb:slot3 hsgpl -peb:slot8 hfdc

Well, and if everything went well, you now have a slightly different Master Title Screen. Right above the lower color band it says

PRESS ANY KEY, SELECT GRM-BASE

Your HSGPL is ready to use now. Did you already notice that the system feels somewhat faster? Indeed, the GROM simulator in the HSGPL is much faster than the real GROMs.

First tests

• Press the space key. Do not press any number button yet; they are used to select the GROM base, and as long as these banks are empty you will make your console lock up.
• Press 1 for TI-BASIC

In TI BASIC, enter

CALL HSGPL

You should be taken into the HSGPL loader. Please consult the manual of the HSGPL for a description how to continue from here. To leave, press FCTN-9 or QUIT or simply Q.

You can also press FCTN-8 in the program selection menu (where you selected TI-BASIC). This should bring you to the HSGPL loader as well.

You must copy the console GROMs in each memory bank that you wish to use with a cartridge. If you simply load a cartridge into a memory bank but forget to also copy the console GROMs, you will get a lock-up when you select the memory bank.

Saving the console GROMs

In the HSGPL loader you notice a set of "GROM x" entries with x from 0 to 7, and four "ROM" entries (0-3). The asterisk indicates that this area is selected for loading or saving. We first deselect all items:

• Deselect GROM 3-7 by pressing each key from 3 to 7.
• Deselect ROM 0-3 by pressing FCTN-0 to FCTN-3
• Select GROM 0-2 by pressing each of the keys 0-2.

Specify a file name first. Press F to enter a file name. You should see a cursor blinking in the field for the file name.

DSK1.GROM0

Now press S to save the memory areas to files GROM0, GROM1, and GROM2 on the image in DSK1.

Copying the console GROMs to another memory bank

Enter the HSGPL laoder if your are not yet there. Press the > (greater than) key, and you will see the contents of the next memory bank. This bank (1) will be selected on the Master Title Screen when you press the 1 key. Pressing < (less than) will put you one bank backwards.

As you can see, each memory area is empty. You must now load the console GROMs into the GROM 0-2 locations.

Specify the first file name first by pressing F like above. Now press L for Load. You should get a warning message:

Caution! Load Grom 0? Confirm with "Y"

This is what you want, so press Y. You will see that the remaining two files are subsequently loaded into the memory areas.

From now on, this bank will be selectable on the Master Title Screen.

Saving a cartridge

Start up the emulation with HSGPL and a cartridge inserted. This will partly deactivate the HSGPL, which is indicated by some warning messages. You are still able to dump the cartridge, though.

mess ti99_4a -peb:slot3 hsgpl -peb:slot8 hfdc -flop1 mydumps.dsk -cart ti_invaders.rpk

Just like above, type F to set a file name for saving. Enter

DSK1.INVADERS

Loading a cartridge

Now restart the emulation without the cartridge.

mess ti99_4a -peb:slot3 hsgpl -peb:slot8 hfdc -flop1 mydumps.dsk

Press F to enter the file name, then L to load.

After all files are loaded you can exit the HSGPL loader and check the program list of the memory bank that you just loaded the contents into.

Using the HSGPL for different systems

The HSGPL may be set up for 40 column operation or for 80 columns. The first option is used when you have a standard TI console; the second is recommended for those that have an EVPC video card, which adds 80 column capabilities.

The problem is that either version should not be used with the wrong system. This is handled by MESS automatically, so you do not have to care about this. If you have a look at the nvram folder in your MESS installation directory you will notice that it contains subfolders named after the systems that were run. For instance, you will find a ti99_4a and a ti99_4ev folder which correspond to the stock console and to the EVPC-enhanced system.

You should now do the flash process for each system that you want to use the HSGPL card in. Each system get individual hsgpl files so there is no mix-up.

The SGCPU

The SGCPU system is a comparably new TI computer system that was designed by the SNUG people and consists of an expansion card that contains the complete chipset of the original TI console. However, instead of the standard GROMs you have to use the HSGPL. And it also requires the EVPC card.

Accordingly, you will have to create a suitable HSGPL card first before you can use the SGCPU. This is done quite easily (when you know it, everything sounds easy):

• Prepare a HSGPL card on a ti99_4ev system.
• Copy the hsgpl files to the ti99_4p subdirectory of the nvram directory.