User Tools

Site Tools


project:homebrew:wsbackuptool

WS Backup Tool

This utility allows you to:

  • Backup the console IPL / boot ROM,
  • Backup and restore cartridge data,
  • Backup, restore and erase cartridge save data (SRAM and EEPROM supported),
  • Reflash self-reflashable cartridges, like the WonderWitch (experimental).

Downloads

Instructions

If loading the .bfb program was successful, you should be greeted with the following option screen:

You shouldn't need to change the serial port speed from the 38400 bps default, but if you experience connection stability issues, feel free to change it to 9600 bps.

Console IPL / boot ROM backup

To create a console IPL / boot ROM backup:

  1. Initiate an XMODEM download on your PC.
  2. Select the Transfer IPL… option.
  3. Wait for the XMODEM download to finish.

Cartridge backup

To create a cartridge backup:

  1. Select the Cart Backup… option.
  2. Ensure that the cartridge configuration (ROM, SRAM, EEPROM size; ROM access width, speed) is correct.
    • The tool will try to auto-detect cartridge configuration based on its header. Most of the time, you should not need to change any option.
  3. Initiate an XMODEM download on your PC.
  4. To back up cartridge data, select Backup ROM…. To backup up save data, select the Backup SRAM…, or Backup EEPROM… option, depending on cartridge.
    • Most cartridges will only have SRAM or EEPROM, but not both.
  5. Wait for the XMODEM download to finish.

Cartridge restore

To restore cartridge save data from a backup:

  1. Select the Cart Restore… option.
  2. Ensure that the cartridge configuration (SRAM, EEPROM size; ROM access width, speed) is correct.
    • The tool will try to auto-detect cartridge configuration based on its header. Most of the time, you should not need to change any option.
  3. Select the Restore SRAM…, or Restore EEPROM… option, depending on cartridge.
    • Most cartridges will only have SRAM or EEPROM, but not both.
  4. Initiate an XMODEM upload on your PC.
  5. Wait for the XMODEM upload to finish.

Cartridge erase

To erase cartridge save data:

  1. Select the Cart Erase… option.
  2. Ensure that the cartridge configuration (SRAM, EEPROM size; ROM access width, speed) is correct.
    • The tool will try to auto-detect cartridge configuration based on its header. Most of the time, you should not need to change any option.
  3. Select the Erase SRAM…, or Erase EEPROM… option, depending on cartridge.
  4. Wait for the erase process to finish.

Cartridge flashing

To flash cartridge data:

  1. Make sure your cartridge is self-flashable (supports the 2003 mapper's flashing protocol - port 0xCE), and that its flash chip is supported (see below).
  2. Select the Cart Flash (Expert) option.
  3. Set the Size to the size of the data you want to flash to the cartridge.
    • Only data padded to a multiple of 64 kilobytes is supported.
  4. Set the Mode based on the flash chip used (see below)
  5. Select the Write Flash… option.
  6. Initiate an XMODEM upload on your PC.
  7. Wait for the XMODEM upload to finish.
  8. Check the status message at the bottom.
    1. If it says Header bootable, the cartridge will boot a WSC/SC correctly.
    2. If it says Header not bootable, the cartridge will not boot a WSC/SC correctly. As the 2003 mapper does not support hot swapping, you must either reflash the cartridge without turning off the console, or risk having to use an external device to reflash it.

Supported flash chips:

  • generic flash chips using AAh/55h/A0h (“Regular” mode)
  • Fujitsu MBM29DL400/MBM29DL800 (“WonderWitch” mode)
  • Micron JS28Fxxx29EWx (“WSFM” mode)
  • MX29L3211 (“MX29L3211” mode)

Changelog

v0.2.1 (11th June 2024)

  • Added support for flashing MX29L3211 chips.
  • Fixed accelerated writing of MBM29DLx00 and JS28Fxx29EWx chips.
  • Added “Header bootable”/“Header not bootable” warning.

v0.2.0 (9th April 2024)

  • Improve SRAM chip detection.
  • Allow zeroing SRAM/EEPROM size values.

v0.1.9 (20th February 2024)

  • Allow pressing B to move to the end of the menu.
  • Improve flashing code.
  • Update toolchain.
project/homebrew/wsbackuptool.txt · Last modified: 2024/06/11 15:39 by asie