mirror of
https://github.com/spicyjpeg/573in1.git
synced 2025-01-22 19:52:05 +01:00
Add documentation and flash dump splitter script
This commit is contained in:
spicyjpeg
parent
55ac5478bf
commit
ffa70d66fb
@ -135,11 +135,25 @@ if(EXISTS "${XORRISO_PATH}")
|
||||
-preparer_id "CART_TOOL BUILD SCRIPT"
|
||||
-map cdreadme.txt README.TXT
|
||||
-map cart_tool.psexe PSX.EXE
|
||||
-clone PSX.EXE QSY.DXD
|
||||
-clone PSX.EXE SSW.BXF
|
||||
-clone PSX.EXE TSV.AXG
|
||||
-clone PSX.EXE GSE.NXX
|
||||
-clone PSX.EXE NSE.GXX
|
||||
-clone PSX.EXE OSE.FXX
|
||||
-clone PSX.EXE QSU.DXH
|
||||
-clone PSX.EXE QSX.DXE
|
||||
-clone PSX.EXE QSY.DXD
|
||||
-clone PSX.EXE QSZ.DXC
|
||||
-clone PSX.EXE RSU.CXH
|
||||
-clone PSX.EXE RSV.CXG
|
||||
-clone PSX.EXE RSW.CXF
|
||||
-clone PSX.EXE RSZ.CXC
|
||||
-clone PSX.EXE SSW.BXF
|
||||
-clone PSX.EXE SSX.BXE
|
||||
-clone PSX.EXE SSY.BXD
|
||||
-clone PSX.EXE TSV.AXG
|
||||
-clone PSX.EXE TSW.AXF
|
||||
-clone PSX.EXE TSX.AXE
|
||||
-clone PSX.EXE TSY.AXD
|
||||
-clone PSX.EXE TSZ.AXC
|
||||
OUTPUT cart_tool.iso
|
||||
DEPENDS cart_tool
|
||||
COMMENT "Building CD-ROM image"
|
||||
|
||||
@ -6,35 +6,35 @@
|
||||
|
||||
"App": {
|
||||
"startupWorker": {
|
||||
"initIDE": "Initializing IDE devices...",
|
||||
"initFAT": "Attempting to mount FAT filesystem...",
|
||||
"initIDE": "Initializing IDE devices...\nDo not turn off the 573.",
|
||||
"initFAT": "Attempting to mount FAT filesystem...\nDo not turn off the 573.",
|
||||
"loadResources": "Loading resource pack..."
|
||||
},
|
||||
"cartDetectWorker": {
|
||||
"readDigitalIO": "Retrieving digital I/O board ID...",
|
||||
"readCart": "Reading security cartridge...",
|
||||
"readCart": "Reading security cartridge...\nDo not turn off the 573.",
|
||||
"identifyGame": "Attempting to identify game..."
|
||||
},
|
||||
"cartEraseWorker": {
|
||||
"erase": "Erasing cartridge...",
|
||||
"erase": "Erasing cartridge...\nDo not turn off the 573.",
|
||||
"error": "An error occurred while erasing the cartridge's EEPROM. The unlocking key may or may not have been successfully changed.\n\nPress the Test button to view debug logs."
|
||||
},
|
||||
"cartReflashWorker": {
|
||||
"setDataKey": "Setting new unlocking key...",
|
||||
"write": "Writing new data to cartridge...",
|
||||
"setDataKey": "Setting new unlocking key...\nDo not turn off the 573.",
|
||||
"write": "Writing new data to cartridge...\nDo not turn off the 573.",
|
||||
"idError": "The selected game is not compatible with the currently inserted cartridge, as it requires one with a valid DS2401 identifier.",
|
||||
"writeError": "An error occurred while reflashing the cartridge. The unlocking key may or may not have been successfully changed.\n\nPress the Test button to view debug logs."
|
||||
},
|
||||
"cartUnlockWorker": {
|
||||
"read": "Dumping cartridge...",
|
||||
"read": "Dumping cartridge...\nDo not turn off the 573.",
|
||||
"identifyGame": "Attempting to identify game..."
|
||||
},
|
||||
"cartWriteWorker": {
|
||||
"write": "Writing new data to cartridge...",
|
||||
"write": "Writing new data to cartridge...\nDo not turn off the 573.",
|
||||
"error": "An error occurred while writing to the cartridge's EEPROM.\n\nPress the Test button to view debug logs."
|
||||
},
|
||||
"cartDumpWorker": {
|
||||
"save": "Saving cartridge dump...",
|
||||
"save": "Saving cartridge dump...\nDo not turn off the 573.",
|
||||
"success": "A dump of the cartridge and all its identifiers has been saved as %s in the root of the drive. The dump can be decoded and viewed using the decodeDump.py script provided with this tool.",
|
||||
"error": "An error occurred while saving the dump to the hard drive. Turn off the system and make sure the drive is connected to the IDE bus properly, set as secondary and formatted with a single FAT16, FAT32 or exFAT partition.\n\nPress the Test button to view debug logs."
|
||||
},
|
||||
@ -43,12 +43,12 @@
|
||||
"generate": "Generating QR code..."
|
||||
},
|
||||
"romDumpWorker": {
|
||||
"init": "Creating dump directory...",
|
||||
"dumpBIOS": "Dumping BIOS ROM...",
|
||||
"dumpRTC": "Dumping RTC RAM...",
|
||||
"dumpFlash": "Dumping internal flash...",
|
||||
"dumpPCMCIA1": "Dumping PCMCIA card in slot 1...",
|
||||
"dumpPCMCIA2": "Dumping PCMCIA card in slot 2...",
|
||||
"init": "Creating dump directory...\nDo not turn off the 573.",
|
||||
"dumpBIOS": "Dumping BIOS ROM...\nDo not turn off the 573.",
|
||||
"dumpRTC": "Dumping RTC RAM...\nDo not turn off the 573.",
|
||||
"dumpFlash": "Dumping internal flash...\nDo not turn off the 573.",
|
||||
"dumpPCMCIA1": "Dumping PCMCIA card in slot 1...\nDo not turn off the 573.",
|
||||
"dumpPCMCIA2": "Dumping PCMCIA card in slot 2...\nDo not turn off the 573.",
|
||||
"success": "All dumps have been saved to the %s directory in the root of the drive.",
|
||||
"initError": "An error occurred while creating the dump directory. Turn off the system and make sure the drive is connected to the IDE bus properly, set as secondary and formatted with a single FAT16, FAT32 or exFAT partition.\n\nPress the Test button to view debug logs.",
|
||||
"dumpError": "An error occurred while writing dumps to the hard drive. Ensure the drive has at least 32 MB of free space (256 MB if both PCMCIA cards are inserted) and the filesystem is not damaged.\n\nPress the Test button to view debug logs."
|
||||
|
||||
BIN
doc/assets/buttonMapping.png
Normal file
BIN
doc/assets/buttonMapping.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 13 KiB |
BIN
doc/assets/cartInfoLocked.png
Normal file
BIN
doc/assets/cartInfoLocked.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
BIN
doc/assets/cartInfoUnlocked.png
Normal file
BIN
doc/assets/cartInfoUnlocked.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
BIN
doc/assets/cartReflash.png
Normal file
BIN
doc/assets/cartReflash.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
BIN
doc/assets/editSystemID.png
Normal file
BIN
doc/assets/editSystemID.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
BIN
doc/assets/qrDump.png
Normal file
BIN
doc/assets/qrDump.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9.0 KiB |
BIN
doc/assets/zs01RecommendedKey.png
Normal file
BIN
doc/assets/zs01RecommendedKey.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 15 KiB |
77
doc/formats.md
Normal file
77
doc/formats.md
Normal file
@ -0,0 +1,77 @@
|
||||
|
||||
# Data formats
|
||||
|
||||
## Security cartridge dump (.573 file)
|
||||
|
||||
Security cartridge dumps saved to IDE hard drives use a custom structured data
|
||||
format, consisting of a raw dump of the cartridge's EEPROM preceded by a 44-byte
|
||||
header. The data can be broken down as follows:
|
||||
|
||||
| Offset | Length | Description |
|
||||
| -----: | ------: | :-------------------------------------------------------- |
|
||||
| 0 | 1 | EEPROM chip type: 1 = X76F041, 2 = reserved, 3 = ZS01 |
|
||||
| 1 | 1 | Dump flags, see below |
|
||||
| 2 | 2 | _Reserved_ (should be zero) |
|
||||
| 4 | 8 | System identifier, zerofilled if none such |
|
||||
| 12 | 8 | Cartridge DS2401 identifier, zerofilled if none such |
|
||||
| 20 | 8 | Cartridge ZS01 identifier, zerofilled if none such |
|
||||
| 28 | 8 | Key used to unlock the cartridge, zerofilled if none such |
|
||||
| 36 | 8 | EEPROM configuration registers, zerofilled if none such |
|
||||
| 44 | 112-512 | EEPROM contents (512 bytes for X76F041, 112 for ZS01) |
|
||||
|
||||
The dump flags field is a single-byte bitfield containing the following flags:
|
||||
|
||||
| Bit | Description |
|
||||
| --: | :----------------------------------------------------------------- |
|
||||
| 0 | System has an identifier (i.e. a digital I/O board) |
|
||||
| 1 | Cartridge has a DS2401 chip |
|
||||
| 2 | EEPROM configuration registers present in the dump |
|
||||
| 3 | System identifier present in the dump (requires bit 0) |
|
||||
| 4 | Cartridge DS2401 identifier present in the dump (requires bit 1) |
|
||||
| 5 | Cartridge ZS01 identifier present in the dump |
|
||||
| 6 | Unprotected EEPROM data present in the dump |
|
||||
| 7 | Protected EEPROM data and key present in the dump (requires bit 6) |
|
||||
|
||||
**NOTE**: bit 0 being set without bit 3 also being set means the tool was able
|
||||
to detect the presence of a digital I/O board, but could not read its
|
||||
identifier. The same goes for bits 1 and 4 respectively for cartridges with a
|
||||
DS2401 chip.
|
||||
|
||||
## Security cartridge dump (QR code)
|
||||
|
||||
The format used by QR code dumps is essentially the same as `.573` files, but
|
||||
with an additional layer of compression and a custom base-41 encoding on top of
|
||||
the raw data. Scanning a QR code generated by the tool yields a string similar
|
||||
to this one:
|
||||
|
||||
```
|
||||
573::OGI8APY-U7W9553SDY9J+F.TGR1XY92YKJFAGN16ALNTMDDWGM0-U2MPP:60M3NJO1.TU05T5QZ376SRN4S3LFHHGXNTSA6ZSTSQPZBBA96RCXZQ6M01E1CTKR7941MH9D7B0Y.:JZ0PN8K2000::
|
||||
```
|
||||
|
||||
In order to extract the dump data from such a string, a decoder must:
|
||||
|
||||
1. remove any framing (the `573::` prefix at the beginning of the string and the
|
||||
`::` suffix at the end);
|
||||
2. decode the base-41 encoded string into an array of bytes (see below);
|
||||
3. decompress the decoded binary data.
|
||||
|
||||
The base-41 encoding replaces each group of 2 bytes in the compressed data with
|
||||
a group of 3 characters out of a custom 41-character set (the data is padded to
|
||||
an even number of bytes in order for this to work). It can be undone using the
|
||||
following pseudocode:
|
||||
|
||||
```py
|
||||
CHARSET = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ+-./:"
|
||||
|
||||
while not isEndOfData(input):
|
||||
a = findCharacterInString(CHARSET, readByte(input))
|
||||
b = findCharacterInString(CHARSET, readByte(input))
|
||||
c = findCharacterInString(CHARSET, readByte(input))
|
||||
|
||||
value = a + (b * 41) + (c * 1681)
|
||||
writeByte(output, value >> 8)
|
||||
writeByte(output, value & 0xff)
|
||||
```
|
||||
|
||||
The contents of the dump can then obtained by running the decoded data through
|
||||
zlib's `decompress()` function or a zlib-compatible decompressor.
|
||||
266
doc/manual.md
Normal file
266
doc/manual.md
Normal file
@ -0,0 +1,266 @@
|
||||
|
||||
# User's manual
|
||||
|
||||
## Contents
|
||||
|
||||
- [Introduction](#introduction)
|
||||
- [Getting started](#getting-started)
|
||||
- [Unlocking and dumping cartridges](#unlocking-and-dumping-cartridges)
|
||||
- [Editing the system identifier](#editing-the-system-identifier)
|
||||
- [Converting cartridges](#converting-cartridges)
|
||||
- [Connecting a hard drive](#connecting-a-hard-drive)
|
||||
- [FAQ and troubleshooting](#faq-and-troubleshooting)
|
||||
|
||||
## Introduction
|
||||
|
||||
This tool will let you:
|
||||
|
||||
- inspect and dump the serial numbers and EEPROM contents of any System 573
|
||||
security cartridge;
|
||||
- reset cartridges that have been paired to a 573's digital I/O board during
|
||||
installation, so that they can be reused on a different system;
|
||||
- erase cartridges and convert them for use with any game that uses the same
|
||||
cartridge type;
|
||||
- dump your 573's internal flash memory, RTC RAM, BIOS ROM as well as any PCMCIA
|
||||
flash cards inserted into it.
|
||||
|
||||
It will *not* let you:
|
||||
|
||||
- run System 573 games that require a security cartridge without owning one of
|
||||
the correct type;
|
||||
- change your digital I/O board's serial number (it is stored in a read-only
|
||||
chip);
|
||||
- get around a game's I/O board, PCMCIA card or other hardware requirements.
|
||||
|
||||
This guide assumes you already have some basic knowledge of System 573 hardware
|
||||
(games, I/O board types and so on) and arcade hardware more in general. If not,
|
||||
you may want to familiarize yourself with the basics before proceeding. Reading
|
||||
this guide in its entirety before using the tool for the first time is highly
|
||||
recommended as well.
|
||||
|
||||
### Disclaimer
|
||||
|
||||
This tool is provided with *no warranty whatsoever* and is not guaranteed to
|
||||
work with your specific 573 setup or security cartridges. Additionally, it is
|
||||
possible to **permanently brick** your cartridges by using it improperly. The
|
||||
authors take no responsibility for cartridges bricked or otherwise damaged,
|
||||
*even if accidentally or due to bugs*, by this tool.
|
||||
|
||||
## Getting started
|
||||
|
||||
In order to use the tool you will need the following:
|
||||
|
||||
- **A System 573** (`GX700-PWB(A)` PCB) equipped with a compatible ATAPI CD-ROM
|
||||
or DVD-ROM drive.
|
||||
- **A JAMMA setup** consisting of an appropriate power supply, a monitor or
|
||||
upscaler capable of displaying 15kHz signals and *at least* the player 1 left,
|
||||
right and start buttons. If your 573 is installed in a DDR, DDR Solo,
|
||||
DrumMania or Dance Maniax cabinet you may leave it in there as the tool has
|
||||
mappings for the wiring of those cabinets' buttons. Note that JVS input
|
||||
devices connected to the JVS port of the 573 are currently not supported.
|
||||
- **A blank CD-R to burn the tool to**. Depending on the drive installed in your
|
||||
573, a DVD-R, DVD+R or a rewritable disc (CD-RW, DVD-RW, DVD+RW) may also
|
||||
work.
|
||||
|
||||
You may additionally want the following optional items:
|
||||
|
||||
- **A digital I/O board** (`GX894-PWB(B)` PCB, also known as "MP3 board" or
|
||||
"digital sound PCB") mounted on top of the 573 motherboard. If one is
|
||||
installed, the tool will display its serial number and offer the ability to
|
||||
pair cartridges to it. If not, the serial number of any digital I/O board can
|
||||
still be entered manually.
|
||||
- **An IDE hard drive, CF card, SD card adapter or IDE-to-SATA adapter**
|
||||
connected to the same IDE bus as the CD-ROM drive, for dumping cartridges or
|
||||
the 573's internal storage. See
|
||||
[Connecting a hard drive](#connecting-a-hard-drive) for more details.
|
||||
|
||||
To get started, burn the provided CD-ROM image to a disc using your burning tool
|
||||
of choice, then remove any game disc from your 573 and replace it with your
|
||||
burned disc. Make sure DIP switch 4 (the rightmost one) is off, turn on or power
|
||||
cycle your 573 and, if everything goes well, it should boot into a warning about
|
||||
security cartridges. Press the start button and you will get to this screen:
|
||||
|
||||
<p align="center">
|
||||
<img src="assets/buttonMapping.png" alt="Button mapping selection" />
|
||||
</p>
|
||||
|
||||
Press the start button repeatedly until the button mapping that most closely
|
||||
matches your setup is highlighted, then hold it down for about a second to
|
||||
confirm your selection. From now on you will be able to navigate the tool using
|
||||
the left and right (or up and down) buttons on your cabinet or JAMMA setup.
|
||||
|
||||
**NOTE**: the tool is also available as a self-contained executable (`.psexe`)
|
||||
file in case you have another means of running arbitrary software on your
|
||||
system. That said, if that is the case then you will likely not need to read
|
||||
most of this guide.
|
||||
|
||||
## Unlocking and dumping cartridges
|
||||
|
||||
### Cartridge types
|
||||
|
||||
There are several different kinds of cartridges, most of which are equipped with
|
||||
additional game-specific hardware such as serial ports, however all of them fall
|
||||
into one of three categories depending on the actual security-related hardware
|
||||
they feature:
|
||||
|
||||
- **X76F041**: the earliest and simplest cartridge type, consisting only of a
|
||||
512-byte password protected EEPROM. Used by early non-Bemani games.
|
||||
- **X76F041 + DS2401**: similar to X76F041 cartridges but with an additional
|
||||
unique serial number (DS2401 chip), a copy of which is stored in the EEPROM
|
||||
and validated by the game. Used by most non-Bemani games, some early Bemani
|
||||
titles and as an installation cartridge for games with dual installation and
|
||||
game cartridges.
|
||||
- **ZS01 + DS2401**: introduced with later Bemani games such as DDR 4thMIX,
|
||||
these were supposed to be more "secure" than their X76F041 counterparts. They
|
||||
offer 112 bytes of storage, support for identification without a password and
|
||||
*two* unique identifiers (only one of which is normally used).
|
||||
|
||||
There are actually two more cartridge types, based on the X76F100 EEPROM chip.
|
||||
Even though support for these cartridges is present in virtually all 573 games,
|
||||
there is no evidence whatsoever of them having ever been manufactured by Konami
|
||||
and the tool does not support them currently.
|
||||
|
||||
### Unlocking a cartridge
|
||||
|
||||
All cartridges must be unlocked using an 8-byte key prior to reading or writing
|
||||
their contents. This key is different for each game; the tool includes a list of
|
||||
the most common 573 games with their respective keys. When first selecting
|
||||
*Manage security cartridge* from the main menu, you will get to a screen
|
||||
displaying basic information about your digital I/O board (if any) and the
|
||||
cartridge:
|
||||
|
||||
<p align="center">
|
||||
<img src="assets/cartInfoLocked.png" alt="Cartridge information (locked)" />
|
||||
</p>
|
||||
|
||||
You will then have to unlock the cartridge by either selecting which game it
|
||||
belongs to from the built-in list or entering a custom key manually.
|
||||
|
||||
**NOTE**: cartridges that have been previously erased and converted to another
|
||||
game will require the new game's key, so the label on the cartridge may not
|
||||
match the actual key required to unlock it. If the cartridge has been previously
|
||||
erased but not converted, its key will be `00-00-00-00-00-00-00-00` by default.
|
||||
|
||||
As ZS01 cartridges allow for the first 32 bytes of data to be read without
|
||||
providing a key, the tool will automatically read them and attempt to determine
|
||||
which game the cartridge belongs to from those. If a match is found, an
|
||||
appropriate unlocking key will be suggested and an option to use it will appear
|
||||
at the top of the key list:
|
||||
|
||||
<p align="center">
|
||||
<img src="assets/zs01RecommendedKey.png" alt="ZS01 key selection" />
|
||||
</p>
|
||||
|
||||
Once a key is selected, if unlocking succeeds, the contents of the cartridge
|
||||
will be read and the screen will be updated with information about them:
|
||||
|
||||
<p align="center">
|
||||
<img src="assets/cartInfoUnlocked.png" alt="Cartridge information (unlocked)" />
|
||||
</p>
|
||||
|
||||
If unlocking fails you may want to try using another key, however keep in mind
|
||||
that all types of cartridges have lockout mechanisms to deter attempts to guess
|
||||
the key:
|
||||
|
||||
- X76F041 and X76F041 + DS2401 cartridges will allow for up to (usually) either
|
||||
3 or 9 attempts depending on the game. If this number is exceeded without a
|
||||
successful unlock, **the chip will lock out any further access** and the
|
||||
cartridge will thus become **permanently bricked** with no way to restore
|
||||
access.
|
||||
- ZS01 cartridges will similarly only allow for a limited number of unlock
|
||||
attempts, but exceeding it will only result in the contents of the EEPROM
|
||||
being erased and the key being reset to `00-00-00-00-00-00-00-00`, without
|
||||
bricking the chip.
|
||||
|
||||
### Saving cartridge dumps
|
||||
|
||||
After unlocking a cartridge, it is recommended to save a backup of its original
|
||||
state before modifying its contents. The tool offers two different ways to dump
|
||||
cartridges, either to a `.573` file on the currently connected IDE drive (see
|
||||
[Connecting a hard drive](#connecting-a-hard-drive) for more details) or as a QR
|
||||
code that can be scanned and converted to a dump file with the help of the
|
||||
`decodeDump.py` Python script provided alongside the tool. A QR code dump will
|
||||
look like this:
|
||||
|
||||
<p align="center">
|
||||
<img src="assets/qrDump.png" alt="QR code dump" />
|
||||
</p>
|
||||
|
||||
When scanned, the code will yield the dump encoded as a string beginning with
|
||||
`573::`. The dump can be decoded into readable data by invoking `decodeDump.py`
|
||||
followed by the string enclosed in quotes in a terminal:
|
||||
|
||||
```
|
||||
$ ./decodeDump.py "573::OGI8AP ... 8K2000::"
|
||||
Digital I/O ID: 01-12-34-56-78-9a-bc-3d
|
||||
Digital I/O SN: 2990-0818
|
||||
|
||||
Cartridge type: Konami ZS01 (PIC16CE625)
|
||||
DS2401 identifier: 01-07-06-05-04-03-02-d2
|
||||
...
|
||||
```
|
||||
|
||||
`decodeDump.py -i` can also be used to display the contents of a dump file:
|
||||
|
||||
```
|
||||
$ ./decodeDump.py -i path/to/dump.573
|
||||
Digital I/O ID: 01-12-34-56-78-9a-bc-3d
|
||||
Digital I/O SN: 2990-0818
|
||||
|
||||
Cartridge type: Konami ZS01 (PIC16CE625)
|
||||
DS2401 identifier: 01-07-06-05-04-03-02-d2
|
||||
...
|
||||
```
|
||||
|
||||
See [Data formats](formats.md) for a technical breakdown of the dump format.
|
||||
|
||||
## Editing the system identifier
|
||||
|
||||
TODO: add this section
|
||||
|
||||
## Converting cartridges
|
||||
|
||||
TODO: add this section
|
||||
|
||||
## Connecting a hard drive
|
||||
|
||||
TODO: add this section
|
||||
|
||||
## FAQ and troubleshooting
|
||||
|
||||
### I cannot get past the BIOS "hardware error" screen and into the tool
|
||||
|
||||
- Make sure the disc image has been burned correctly (and not by e.g. dragging
|
||||
the image file onto the disc). The disc should contain a bunch of files named
|
||||
`README.TXT`, `PSX.EXE` and so on.
|
||||
- Try using a different disc and/or another CD-ROM drive. A list of drives known
|
||||
to be compatible with the 573 BIOS can be found
|
||||
[here](https://psx-spx.consoledev.net/konamisystem573/#known-working-replacement-drives).
|
||||
- Ensure the BIOS is not reporting an actual hardware error with the 573. A
|
||||
CD-ROM error will result in `CDR BAD` being displayed, while other errors will
|
||||
be reported with the chip that failed. A list of chips checked by the BIOS can
|
||||
be found [here](https://psx-spx.consoledev.net/konamisystem573/#boot-sequence).
|
||||
|
||||
### I get an error about the CD-ROM being incorrect
|
||||
|
||||
- You have booted into the game installed on the 573's flash rather than from
|
||||
the disc. Turn off DIP switch 4 (the rightmost one) and power cycle the 573.
|
||||
|
||||
### My cartridge does not get recognized
|
||||
|
||||
- Try scraping off any oxidation layer from the cartridge's contacts by rubbing
|
||||
them gently using an eraser and cleaning them.
|
||||
- Ensure the security cartridge connector on the 573 is not worn out, corroded
|
||||
or otherwise damaged.
|
||||
|
||||
### My IDE drive, CF card or adapter does not get recognized
|
||||
|
||||
- Try using a different drive or adapter. Some CF cards, SD card adapters and
|
||||
IDE-to-SATA converters are known to be problematic.
|
||||
- Ensure the drive is formatted with a single FAT32 or exFAT partition. Other
|
||||
file systems such as NTFS are not supported.
|
||||
|
||||
### How do I obtain more information about an error that happened?
|
||||
|
||||
- You may press the test button on your 573 or cabinet at any time to toggle the
|
||||
log window, which will contain detailed information about errors.
|
||||
119
tools/splitFlashDump.py
Executable file
119
tools/splitFlashDump.py
Executable file
@ -0,0 +1,119 @@
|
||||
#!/usr/bin/env python3
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
__version__ = "0.3.4"
|
||||
__author__ = "spicyjpeg"
|
||||
|
||||
import os
|
||||
from argparse import ArgumentParser, Namespace
|
||||
from pathlib import Path
|
||||
from shutil import copyfile
|
||||
from typing import ByteString, Sequence
|
||||
|
||||
## Flash dump splitting
|
||||
|
||||
_FLASH_BANKS: Sequence[str] = "m", "l", "j", "h"
|
||||
_FLASH_BANK_SIZE: int = 0x400000
|
||||
_PCMCIA_BANK_SIZE: int = 0x400000
|
||||
|
||||
def splitFlash(inputPath: Path, outputPath: Path):
|
||||
with open(inputPath, "rb") as _file:
|
||||
for bank in _FLASH_BANKS:
|
||||
with \
|
||||
open(outputPath / f"29f016a.31{bank}", "wb") as even, \
|
||||
open(outputPath / f"29f016a.27{bank}", "wb") as odd:
|
||||
data: ByteString = _file.read(_FLASH_BANK_SIZE)
|
||||
|
||||
even.write(data[0::2])
|
||||
odd.write(data[1::2])
|
||||
|
||||
def splitPCMCIACard(inputPath: Path, outputPath: Path, card: int, size: int):
|
||||
name: str = f"pccard{card}_{size // 0x100000}mb"
|
||||
|
||||
with open(inputPath, "rb") as _file:
|
||||
for bank in range(1, (size // _PCMCIA_BANK_SIZE) + 1):
|
||||
with \
|
||||
open(outputPath / f"{name}_{bank}l", "wb") as even, \
|
||||
open(outputPath / f"{name}_{bank}u", "wb") as odd:
|
||||
data: ByteString = _file.read(_PCMCIA_BANK_SIZE)
|
||||
|
||||
even.write(data[0::2])
|
||||
odd.write(data[1::2])
|
||||
|
||||
## Main
|
||||
|
||||
_PCMCIA_CARD_SIZE: int = 32
|
||||
|
||||
def createParser() -> ArgumentParser:
|
||||
parser = ArgumentParser(
|
||||
description = \
|
||||
"Converts a set of dump files generated by the tool (rtc.bin, "
|
||||
"flash.bin, pcmcia*.bin) to NVRAM files as used by MAME.",
|
||||
add_help = False
|
||||
)
|
||||
|
||||
group = parser.add_argument_group("Tool options")
|
||||
group.add_argument(
|
||||
"-h", "--help",
|
||||
action = "help",
|
||||
help = "Show this help message and exit"
|
||||
)
|
||||
|
||||
group = parser.add_argument_group("PCMCIA card options")
|
||||
for card in ( 1, 2 ):
|
||||
group.add_argument(
|
||||
f"-{card}", f"--pcmcia{card}-size",
|
||||
type = lambda value: int(value, 0),
|
||||
default = _PCMCIA_CARD_SIZE,
|
||||
help = \
|
||||
f"Set size of PCMCIA card in slot {card} in megabytes (default "
|
||||
f"{_PCMCIA_CARD_SIZE})",
|
||||
metavar = "value"
|
||||
)
|
||||
|
||||
group = parser.add_argument_group("File paths")
|
||||
group.add_argument(
|
||||
"-o", "--output",
|
||||
type = Path,
|
||||
default = os.curdir,
|
||||
help = "Path to output directory (current directory by default)",
|
||||
metavar = "dir"
|
||||
)
|
||||
group.add_argument(
|
||||
"input",
|
||||
type = Path,
|
||||
help = "Path to directory containing dumped files"
|
||||
)
|
||||
|
||||
return parser
|
||||
|
||||
def main():
|
||||
parser: ArgumentParser = createParser()
|
||||
args: Namespace = parser.parse_args()
|
||||
|
||||
converted: bool = False
|
||||
|
||||
#if os.path.isfile(args.input / "bios.bin"):
|
||||
#copyfile(args.input / "bios.bin", args.output / "700a01.22g")
|
||||
#converted = True
|
||||
|
||||
if os.path.isfile(args.input / "rtc.bin"):
|
||||
copyfile(args.input / "rtc.bin", args.output / "m48t58")
|
||||
converted = True
|
||||
|
||||
if os.path.isfile(args.input / "flash.bin"):
|
||||
splitFlash(args.input / "flash.bin", args.output)
|
||||
converted = True
|
||||
|
||||
for card, size in enumerate(( args.pcmcia1_size, args.pcmcia2_size ), 1):
|
||||
path: Path = args.input / f"pcmcia{card}.bin"
|
||||
|
||||
if os.path.isfile(path):
|
||||
splitPCMCIACard(path, args.output, card, size * 0x100000)
|
||||
converted = True
|
||||
|
||||
if not converted:
|
||||
parser.error("no suitable files to convert found in input directory")
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
Loading…
x
Reference in New Issue
Block a user