https://github.com/ggnkua/usm

Small tool to ease the creation of Atari ST cart images
https://github.com/ggnkua/usm

Last synced: about 1 month ago
JSON representation

Small tool to ease the creation of Atari ST cart images

• Host: GitHub
• URL: https://github.com/ggnkua/usm
• Owner: ggnkua
• Created: 2023-10-21T12:49:15.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-28T10:14:44.000Z (5 months ago)
• Last Synced: 2024-07-29T09:12:25.811Z (5 months ago)
• Language: C
• Size: 30.3 KB
• Stars: 6
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
USM

===

Small tool to ease the creation of Atari ST cart images.

Usage

-----

From the command line:

`usm [-s] [-d] [-bX] [-fY] image_filename `

where:

- *-s* is optional and allows creation of STEem Engine compatible carts

- *-d* enables creation of diagnostic cartridges (only one program allowed, which will relocate to $fa0004)

- *-c* to switch to the classic way of adding the application to the ROM

- *-bX* allows setting the BSS address to an address other than the default ($only when -c is active, default: $20000)

- *-fY* allows seting the INIT flag. y can be

  - 0       Execute prior to display memory and interrupt vector initialization

  - 1       Execute just before GEMDOS is initialized

  - 3       Execute prior to boot disk

  - 5       Application is a Desk Accessory

  - 6       Application is not a GEM application

  - 7       Application needs parameters

- *image_filename* is the filename of the cart image

- *list of programs to add with optional -b and -f* is a list of ST PRG programs to add to the image, optionally postfixed by a *-b* and/or *-f* to set the parameters for the current file only

More on defaults: The default value for *-b* is $20000, and the default value for *-f* is 0. Passing *-b* and/or *-f* at the start of the parameter list will override the default values. Passing *-b* and/or *-f* after each program in the list, will override the defaults for that file only.

Two modes of operation

----------------------

Until the second release there was a single mode of operation (explained below).

The current default mode is to add a TOS PRG file with a small stub loader included which will copy the actual program from ROM to RAM, try to set up the system as well as it can, and then execute the program from RAM.

The old mode adds the program to ROM and relocates it to run from there, with the BSS start address set in RAM by the user (or default value is used). This mode works for simple applications, but there will be many problems down the road for non properly written applications for this mode (i.e. pretty much all of them).

Caveats

-------

- Only use single file PRG programs. Programs that try to load external files will not work

- TODO: Some sanity checks are performed, but the program is far from bullet proof

- TODO: Date and Time are still set to bogus values

- On BSS, for "old" mode: programs that access the BSS using PC relative code will most likely fail

Building

--------

Use the provided scripts. Or Visual Studio.

Thank yous

----------

Diego Parrilla for supplying the Github actions to automatically build binaries for all platforms, and some other fixes in the code.

tIn/Newline for the original stub loader source code.