SIDE/SIDE2 Firmware
===================

Copyright (c) 2015-2019 Jonathan Halliday <fjc@atari8.co.uk>

Please read LICENSE for licensing details. Visit atari8.co.uk/firmware/ for updates.


CONTENTS
========

In the archive you will find stand-alone files, and those same files on ATR disk images.

ROMs
====

sideload.rom			256K external cart (loader) ROM
oss.rom				256K external cart (loader and OSS carts) ROM
sdxside.rom			SpartaDOS X ROM for SIDE
sdxside2.rom			SpartaDOS X ROM for SIDE2
side.rom			Full 512K ROM (SDX and loader) for SIDE
side2.rom			Full 512K ROM (SDX and loader) for SIDE2
sideoss.rom			Full 512K ROM with SDX, loader, OSS carts, with UFLASH and SIDE DLT flasher
side2oss.rom			Full 512K ROM with SDX, loader, OSS carts, with UFLASH and SIDE2 DLT flasher
		

ATRs
====

side_loader.atr			Loader ROM with UFLASH and SIDE DLT flasher
side2_loader.atr		Loader ROM with UFLASH and SIDE2 DLT flasher
side_oss.atr			Loader/OSS carts ROM with UFLASH and SIDE DLT flasher
side2_oss.atr			Loader/OSS carts ROM with UFLASH and SIDE2 DLT flasher
side_full.atr			Full 512K ROM with SDX and loader, with UFLASH and SIDE DLT flasher
side_full_oss_carts.atr		Full 512K ROM with SDX and loader, with UFLASH and SIDE2 DLT flasher
side2_full_oss_carts.atr	Full 512K ROM with SDX, loader, OSS carts, with UFLASH and SIDE DLT flasher
side2_full.atr			Full 512K ROM with SDX, loader, OSS carts, with UFLASH and SIDE DLT flasher


TOOLS
=====

flash_se.com			DLT flasher for SIDE external cart space (loader)
flash_s2.com			DLT flasher for SIDE2 external cart space (loader)
side.com			DLT flasher for SIDE SDX/full ROM
side2.com			DLT flasher for SIDE2 SDX/full ROM
uflash.xex			Universal flashing tool (requires extended RAM)
sidecfg.xex			Configuration tool for OSS cart ROMs


INSTALLATION
============

If you have U1MB or another 1MB RAM upgrade installed, you can update the SIDE/SIDE2 flash ROM with UFLASH:

* Ensure 1MB of extended RAM is available
* Disable any on-board SpartaDOS X ROM (e.g. U1MB)
* Put the SIDE/SIDE2 switch in the 'down' (SDX) position
* Mount the desired ATR using your preferred SIO2xxx device
* Boot the computer with the SIDE/SIDE2 connected
* Once SDX has booted, type UFLASH.XEX and flash the desired ROM

Important: flash SDX ROMs to the 'SpartaDOS X' slot, 256K loader/OSS ROMs to the 'External cartridge' slot, and 512K 'complete' ROMs to the top-level slot (i.e. the name of the flash chip).

User without 1MB of extended RAM may use the DLT flasher to update the entire ROM, the SDX ROM, or the loader ROM. These flashers - which work on 64K machines - target either the SDX ROM/entire flash ROM (SIDE.COM/SIDE2.COM) or the 'external cart' segment/loader (FLASH_SE.COM/FLASH_S2.COM). Simply type the name of the flasher and it will flash the first '*.ROM' file it finds.


OSS CART ROMS
=============

Eric Bacher (ebiguy) has kindly created four patched OSS programming language cartridge ROMs for use with SIDE/SIDE2. These ROMs appear in the 'OSS' SIDE ROMs, either as complete flash ROM images (SIDEOSS.ROM/SIDE2OSS.ROM) or a 256K image to be flashed to the 'External cartridge' slot. After flashing one of these images, you can use the SIDECFG.XEX tool to force the SIDE cartridge to boot the OSS ROM of your choosing every time you boot the machine. The selection will persist until you choose a different cart ROM by running the tool again. You can also force the loader to become the active ROM again by booting the system with the START, SELECT and OPTION keys simultaneously held down.

These OSS cart ROMs can be used on a stand-alone SIDE/SIDE2 setup with or without SpartaDOS X and with or without the SIDE.SYS driver (which provides SDX access to the Compact Flash hard disk). The ROMs also work on U1MB systems where the SIDE hard disk is driven by the U1MB PBI BIOS. Simply disable the 'ATR swap button' and ensure 'SIDE Cart ROM' is enabled, and you can freely use the selected OSS language cartridge with or without U1MB's SpartaDOS X ROM, hard disk, and XEX loader.


INTELLECTUAL PROPERTY
=====================

Note that while the this firmware is closed-source freeware (as described in LICENSE), it includes a modified version of the GPL licensed High-Speed SIO driver by Matthias Reichl. Special permission was sought and granted to incorporate Matthias' code into this closed-source project. Matthias deserves creadit and recognition for his remarkable work in the area of high-speed SIO on the 8-bit Atari, and the 'alt' U1MB firmware is richer for the inclusion of his driver.

Aside from the aforementioned high-speed SIO driver and the customised SpartaDOS X ROMs included in the archive, all components are the wholly original work of the author and consititute a 'ground-up' rewrite of the original firmware. See the user manual and developers' technical documentation for further details.


ACKNOWLEDGEMENTS
================

As well as the aforementioned Hias, thanks to Micheal St Pierre, Marlin Bates, and everyone in the 1088XEL beta testers discussion. Thanks to Avery Lee, Marius Diepenhorst, Lotharek, Candle O'Sin, TheMontezuma, and many others for your vital contributions and support.


DONATIONS
=========

Since the amount of time required to develop and maintain this firmware is considerable (and at times unmanageable), donations are most welcome and may be made via www.paypal.me/flashjazzcat.


FEEDBACK
========

The author welcomes feedback, suggestions and bug reports.

Enjoy!



FJC July 2019
