Greasweazle: Difference between revisions

From RetroWikipedia
Jump to navigation Jump to search
← Older edit
VisualWikitext
No edit summary
No edit summary
 
Line 7: Line 7:
   | caption      = Greaseweazle V4.1 unit
   | caption      = Greaseweazle V4.1 unit
   | developer    = Keir Fraser
   | developer    = Keir Fraser
   | release_date = 2018 (initial), latest hardware revisions ongoing
   | release_date = 2018 (initial), ongoing revisions
   | type        = Floppy disk flux-level interface
   | type        = Floppy disk flux-level interface
   | cpu          = STM32F103 / STM32F730 / AT32F4xx (varies by model)
   | cpu          = STM32F103 / STM32F730 / AT32F4xx (varies by model)
   | connectors  = USB-C or Micro-USB, 34-pin floppy ribbon connector, power connector
   | connectors  = USB-C or Micro-USB; 34-pin floppy ribbon; power connector
   | licensing    = Open hardware & software (Unlicense for host tools)
   | licensing    = Open hardware & software (Unlicense for host tools)
   | website      = [https://github.com/keirf/greaseweazle GitHub repository]
   | website      = [https://github.com/keirf/greaseweazle GitHub repository]
Line 29: Line 29:
</div>
</div>


'''Greaseweazle''' is an open-source hardware and software system for imaging and writing floppy disks at the magnetic flux level. Developed by [[Keir Fraser]], it supports a wide range of disk formats and is widely used in data recovery, retro-computing preservation, and digital archiving.<ref name="gw-main">{{cite web|url=https://github.com/keirf/greaseweazle|title=Greaseweazle Main Repository|publisher=GitHub|access-date=2025-08-11}}</ref>   
'''Greaseweazle''' is an open-source hardware–software system designed for imaging and writing floppy disks at the magnetic flux level. Developed by [[Keir Fraser]], it supports a broad range of disk formats and is widely used in data recovery, retro-computing preservation, and digital archiving.<ref name="gw-main">{{cite web|url=https://github.com/keirf/greaseweazle|title=Greaseweazle Main Repository|publisher=GitHub|access-date=2025-08-11}}</ref>   
The project’s openness, affordability, and broad compatibility have made it a key alternative to proprietary solutions such as KryoFlux.<ref name="decromancer">{{cite web|url=https://decromancer.ca/greaseweazle/|title=Greaseweazle Overview|publisher=Decromancer|access-date=2025-08-11}}</ref>
Its openness, affordability, and compatibility have made it a recognised alternative to proprietary solutions such as KryoFlux.<ref name="decromancer">{{cite web|url=https://decromancer.ca/greaseweazle/|title=Greaseweazle Overview|publisher=Decromancer|access-date=2025-08-11}}</ref>


== Background ==
== Background ==
Greaseweazle originated in 2018 as a personal project by Keir Fraser, known in retro-computing circles for his work on open hardware and firmware for disk imaging. Early iterations were based on inexpensive STM32F103 "Blue Pill" boards before evolving into dedicated PCBs with enhanced electrical protection, higher performance MCUs, and USB-C connectivity.<ref name="gw-wiki">{{cite web|url=https://github.com/keirf/greaseweazle/wiki|title=Greaseweazle Documentation|publisher=GitHub Wiki|access-date=2025-08-11}}</ref>   
Greaseweazle began in 2018 as a personal project by Keir Fraser, known in retro-computing circles for developing open hardware and firmware for disk imaging. Initial versions used low-cost STM32F103 “Blue Pill” boards before evolving into custom PCBs with improved electrical protection, faster microcontrollers, and USB-C connectivity.<ref name="gw-wiki">{{cite web|url=https://github.com/keirf/greaseweazle/wiki|title=Greaseweazle Documentation|publisher=GitHub Wiki|access-date=2025-08-11}}</ref>   
The project has since built a community of contributors and users, including preservationists, hobbyists, and software historians.
The project has since fostered a community of contributors and users, including preservationists, hobbyists, and computing historians.


== Specifications ==
== Specifications ==


=== Hardware Models ===
=== Hardware Models ===
* '''F1 (Blue Pill)''': STM32F103 MCU; low-cost entry model.
* '''F1 (Blue Pill)''': STM32F103 MCU; entry-level design.
* '''F7''': STM32F730 MCU; adds 12 V support and faster USB transfer.
* '''F7''': STM32F730 MCU; adds 12&nbsp;V support and faster USB transfer rates.
* '''V4 / V4.1''': AT32F4xx MCU; USB-C, input protection, multiple drive support, jumperless firmware updates.<ref name="gw-wiki" />
* '''V4 / V4.1''': AT32F4xx MCU; USB-C, input protection, multiple-drive support, jumperless firmware updates.<ref name="gw-wiki" />


=== Host Software ===
=== Host Software ===
* Command-line utility <code>gw</code> written in Python 3.
* Command-line tool <code>gw</code> implemented in Python&nbsp;3.
* Works on Windows, macOS, Linux, and Raspberry Pi.
* Compatible with Windows, macOS, Linux, and Raspberry&nbsp;Pi.
* Distributed under the Unlicense.<ref name="gw-main" />
* Released under the Unlicense.<ref name="gw-main" />


=== Disk Interface Support ===
=== Disk Interface Support ===
* Works with standard Shugart- and IBM-interface drives:
* Standard Shugart- and IBM-interface drives:
** 3.5-inch and 5.25-inch (34-pin)
** 3.5-inch and 5.25-inch (34-pin)
** 3-inch Amstrad (26-pin, via adapter)
** 3-inch Amstrad (26-pin, via adapter)
** 8-inch (50-pin, via adapter)
** 8-inch (50-pin, via adapter)
* Reads/writes MFM, FM, and GCR encoded formats (with drive compatibility caveats).<ref name="yann">{{cite web|url=https://github.com/keirf/greaseweazle/wiki/Yann-Serra-Tutorial|title=Yann Serra Tutorial|publisher=GitHub Wiki|access-date=2025-08-11}}</ref>
* Reads and writes MFM, FM, and GCR encoded formats, subject to drive compatibility.<ref name="yann">{{cite web|url=https://github.com/keirf/greaseweazle/wiki/Yann-Serra-Tutorial|title=Yann Serra Tutorial|publisher=GitHub Wiki|access-date=2025-08-11}}</ref>


== Usage ==
== Usage ==
A widely referenced [[Yann Serra Tutorial]] (contributed April 2023) provides a structured guide to operation.<ref name="yann" /> Key points include:
A widely referenced [[Yann Serra Tutorial]] (April&nbsp;2023) offers structured guidance on using the system.<ref name="yann" />


=== Access Levels ===
=== Access Levels ===
# **Sector-level**: User-visible data in block-mode images (.img, .adf, .st, etc.).
# '''Sector-level''': User-visible data in block-mode images (.img, .adf, .st, etc.).
# **Track-level**: Preserves formatting, sector layout, and copy-protection metadata (.imd, .edsk).
# '''Track-level''': Preserves formatting, sector layout, and copy-protection metadata (.imd, .edsk).
# **Flux-level**: Captures raw magnetic transitions (.scp, .hfe) for exact reproduction.
# '''Flux-level''': Captures raw magnetic transitions (.scp, .hfe) for exact reproduction.


=== Basic Commands ===
=== Basic Commands ===
Line 68: Line 68:
gw read --format=amiga.amigados MyDisk.adf --drive=A
gw read --format=amiga.amigados MyDisk.adf --drive=A
</pre>
</pre>
Writing back:
Writing an image back:
<pre>
<pre>
gw write --format=amiga.amigados MyDisk.adf --drive=A
gw write --format=amiga.amigados MyDisk.adf --drive=A
</pre>
</pre>
Defaults can be inferred from file extension and cable position.
Defaults are inferred from the file extension and cable position.


=== Supported Profiles ===
=== Supported Profiles ===
The <code>gw</code> tool includes predefined profiles for dozens of systems: Acorn, Amiga, Atari ST, Commodore, IBM PC, Macintosh, MSX, NEC PC-98, ZX Spectrum, and more.
The <code>gw</code> tool includes predefined profiles for dozens of systems, including Acorn, Amiga, Atari&nbsp;ST, Commodore, IBM&nbsp;PC, Macintosh, MSX, NEC&nbsp;PC-98, and ZX Spectrum. Each profile specifies geometry, encoding, and a recommended image suffix.
Each profile specifies geometry, encoding, and recommended image suffix.


=== Troubleshooting ===
=== Troubleshooting ===
* **No Index** – Incorrect drive ID or power issue.
* '''No Index''' – Incorrect drive ID or power issue.
* **Track 0 Not Found** – Insufficient drive power or wrong drive selection.
* '''Track&nbsp;0 Not Found''' – Insufficient drive power or incorrect drive selection.
* **Flux Overflow/Underflow** – USB interference; change port or cable.
* '''Flux Overflow/Underflow''' – USB interference; try another port or cable.
* **Verify Failure** – Disk surface damage; clean disk and heads.
* '''Verify Failure''' – Possible disk damage; clean the disk and drive heads.


=== Advanced Use ===
=== Advanced Use ===
* **Meta-profiles** (<code>ibm.scan</code>, <code>raw.250</code>, etc.) capture arbitrary sector geometries.
* **Meta-profiles** (<code>ibm.scan</code>, <code>raw.250</code>, etc.) allow capturing arbitrary sector geometries.
* Reading 48-TPI disks with 96-TPI drives via <code>--tracks=…:step=2</code>.
* Reading 48-TPI disks with 96-TPI drives via <code>--tracks=…:step=2</code>.
* **Flux-level** archiving with <code>--adjust-speed</code> and <code>--raw</code> for copy-protected media.
* Flux-level archiving with <code>--adjust-speed</code> and <code>--raw</code> for copy-protected media.
* Support for certain “flippy” 5.25-inch disks using <code>--fake-index</code> on compatible drives.
* Support for certain “flippy” 5.25-inch disks via <code>--fake-index</code> on compatible drives.


=== Third-Party Tools ===
=== Third-Party Tools ===
* **Disk Utilities** – .scp ↔ .ipf conversion.
* **Disk Utilities** – .scp ↔ .ipf conversion.
* **HxC Floppy Emulator** – Exotic format conversions to/from .hfe/.scp.
* **HxC Floppy Emulator** – Conversion of exotic formats to/from .hfe/.scp.
* **SamDisk** – Additional meta-image conversions.
* **SamDisk** – Meta-image format conversions.
* **a8rawconv** – Atari 8-bit conversions.
* **a8rawconv** – Atari 8-bit image conversions.
* **Fluxengine** – Alternative imaging command.
* **Fluxengine** – Alternative imaging software.


=== Custom Profiles ===
=== Custom Profiles ===
Profiles are stored in <code>diskdefs.cfg</code> and can be extended by the user via <code>--diskdefs</code>.
Profiles are stored in <code>diskdefs.cfg</code> and can be extended with <code>--diskdefs</code>.


== Importance in Preservation ==
== Importance in Preservation ==
Greaseweazle has become a staple in retro-computing preservation workflows due to:
Greaseweazle is widely used in retro-computing preservation workflows due to:
* **Openness** – Both hardware and software are under permissive licenses.
* '''Openness''' – Both hardware and software use permissive licences.
* **Low cost** – Uses commodity microcontrollers and standard cables.
* '''Affordability''' – Uses commodity microcontrollers and standard cables.
* **Broad compatibility** – Supports dozens of legacy formats across multiple computing platforms.
* '''Compatibility''' – Supports many legacy formats across diverse computing platforms.
* **Community knowledge base** – Extensive guides, including the Yann Serra tutorial, help non-experts recover and preserve data.<ref name="hn">{{cite web|url=https://news.ycombinator.com/item?id=39961245|title=Discussion on Greaseweazle and retrocomputing|publisher=Hacker News|access-date=2025-08-11}}</ref>
* '''Community resources''' – Documentation, tutorials, and forums assist users in data recovery.<ref name="hn">{{cite web|url=https://news.ycombinator.com/item?id=39961245|title=Discussion on Greaseweazle and retrocomputing|publisher=Hacker News|access-date=2025-08-11}}</ref>


== Key People ==
== Key People ==
* **Keir Fraser** – Project founder and lead developer.
* '''Keir Fraser''' – Project founder and lead developer.
* **Yann Serra** – Contributor of the widely cited usage tutorial.
* '''Yann Serra''' – Contributor of a widely used usage tutorial.
* Community contributors via GitHub issues, pull requests, and Wiki edits.
* Community contributors via GitHub, wiki, and forums.


== Appendix: Supported Disk Profiles ==
== Appendix: Supported Disk Profiles ==
{{Collapse top|title=Click to show/hide full disk profile table from Yann Serra Tutorial}}
{{Collapse top|title=Click to show/hide full disk profile table from Yann Serra Tutorial}}
The following is adapted from the [[Yann Serra Tutorial]] and lists supported disk profiles, geometry, encoding, and preferred image suffixes.
Adapted from the [[Yann Serra Tutorial]], the following table lists selected supported disk profiles with geometry, encoding, and preferred suffixes.


<!-- Example condensed table format; full list would follow this pattern -->
{| class="wikitable sortable"
{| class="wikitable sortable"
! System !! Profile !! Sides !! Cyls !! RPM !! kbit/s !! Sect/trk !! Bytes/sect !! Encoding !! Size (KB) !! Suffix
! System !! Profile !! Sides !! Cyls !! RPM !! kbit/s !! Sect/trk !! Bytes/sect !! Encoding !! Size (KB) !! Suffix
Line 128: Line 126:
| IBM PC || ibm.1440 || 2 || 80 || 300 || 500 || 18 || 512 || MFM-HD || 1440 || .img, .dsk
| IBM PC || ibm.1440 || 2 || 80 || 300 || 500 || 18 || 512 || MFM-HD || 1440 || .img, .dsk
|-
|-
| Macintosh 68K || mac.800 || 2 || 80 || VAR || 375 || 12-8 || 512 || GCR || 800 || .dsk
| Macintosh 68K || mac.800 || 2 || 80 || VAR || 375 || 12–8 || 512 || GCR || 800 || .dsk
|-
|-
| ZX Spectrum || zx.trdos.640 || 2 || 80 || 300 || 250 || 16 || 256 || MFM || 640 || .mgt, .dsk
| ZX Spectrum || zx.trdos.640 || 2 || 80 || 300 || 250 || 16 || 256 || MFM || 640 || .mgt, .dsk
Line 134: Line 132:
| NEC PC-98 || pc98.2hs || 2 || 81 || 300 || 500 || 9 || 1024 || MFM-HD || 1458 || .hdm, .xdf
| NEC PC-98 || pc98.2hs || 2 || 81 || 300 || 500 || 9 || 1024 || MFM-HD || 1458 || .hdm, .xdf
|}
|}
''(Full extended tables, including 3.5", 5.25", 8", and 3" formats, are documented in the official tutorial.)''
''Full extended tables for 3.5", 5.25", 8", and 3" formats are available in the official tutorial.''
{{Collapse bottom}}
{{Collapse bottom}}


== References ==
== References ==
<references />
<references />

Latest revision as of 22:00, 11 August 2025











Greaseweazle
File:Greaseweazle V4.1.jpg
Greaseweazle V4.1 unit
DeveloperKeir Fraser
Release date2018 (initial), ongoing revisions
TypeFloppy disk flux-level interface
CPUSTM32F103 / STM32F730 / AT32F4xx (varies by model)
ConnectorsUSB-C or Micro-USB; 34-pin floppy ribbon; power connector
LicensingOpen hardware & software (Unlicense for host tools)
WebsiteGitHub repository




{{#if:Windows, macOS, Linux|<td styl_

Greaseweazle is an open-source hardware–software system designed for imaging and writing floppy disks at the magnetic flux level. Developed by Keir Fraser, it supports a broad range of disk formats and is widely used in data recovery, retro-computing preservation, and digital archiving.[1] Its openness, affordability, and compatibility have made it a recognised alternative to proprietary solutions such as KryoFlux.[2]

Background

Greaseweazle began in 2018 as a personal project by Keir Fraser, known in retro-computing circles for developing open hardware and firmware for disk imaging. Initial versions used low-cost STM32F103 “Blue Pill” boards before evolving into custom PCBs with improved electrical protection, faster microcontrollers, and USB-C connectivity.[3] The project has since fostered a community of contributors and users, including preservationists, hobbyists, and computing historians.

Specifications

Hardware Models

  • F1 (Blue Pill): STM32F103 MCU; entry-level design.
  • F7: STM32F730 MCU; adds 12 V support and faster USB transfer rates.
  • V4 / V4.1: AT32F4xx MCU; USB-C, input protection, multiple-drive support, jumperless firmware updates.[3]

Host Software

  • Command-line tool gw implemented in Python 3.
  • Compatible with Windows, macOS, Linux, and Raspberry Pi.
  • Released under the Unlicense.[1]

Disk Interface Support

  • Standard Shugart- and IBM-interface drives:
    • 3.5-inch and 5.25-inch (34-pin)
    • 3-inch Amstrad (26-pin, via adapter)
    • 8-inch (50-pin, via adapter)
  • Reads and writes MFM, FM, and GCR encoded formats, subject to drive compatibility.[4]

Usage

A widely referenced Yann Serra Tutorial (April 2023) offers structured guidance on using the system.[4]

Access Levels

  1. Sector-level: User-visible data in block-mode images (.img, .adf, .st, etc.).
  2. Track-level: Preserves formatting, sector layout, and copy-protection metadata (.imd, .edsk).
  3. Flux-level: Captures raw magnetic transitions (.scp, .hfe) for exact reproduction.

Basic Commands

Reading an AmigaDOS disk: 

gw read --format=amiga.amigados MyDisk.adf --drive=A

Writing an image back: 

gw write --format=amiga.amigados MyDisk.adf --drive=A

Defaults are inferred from the file extension and cable position.

Supported Profiles

The gw tool includes predefined profiles for dozens of systems, including Acorn, Amiga, Atari ST, Commodore, IBM PC, Macintosh, MSX, NEC PC-98, and ZX Spectrum. Each profile specifies geometry, encoding, and a recommended image suffix.

Troubleshooting

  • No Index – Incorrect drive ID or power issue.
  • Track 0 Not Found – Insufficient drive power or incorrect drive selection.
  • Flux Overflow/Underflow – USB interference; try another port or cable.
  • Verify Failure – Possible disk damage; clean the disk and drive heads.

Advanced Use

  • **Meta-profiles** (ibm.scan, raw.250, etc.) allow capturing arbitrary sector geometries.
  • Reading 48-TPI disks with 96-TPI drives via --tracks=…:step=2.
  • Flux-level archiving with --adjust-speed and --raw for copy-protected media.
  • Support for certain “flippy” 5.25-inch disks via --fake-index on compatible drives.

Third-Party Tools

  • **Disk Utilities** – .scp ↔ .ipf conversion.
  • **HxC Floppy Emulator** – Conversion of exotic formats to/from .hfe/.scp.
  • **SamDisk** – Meta-image format conversions.
  • **a8rawconv** – Atari 8-bit image conversions.
  • **Fluxengine** – Alternative imaging software.

Custom Profiles

Profiles are stored in diskdefs.cfg and can be extended with --diskdefs.

Importance in Preservation

Greaseweazle is widely used in retro-computing preservation workflows due to:

  • Openness – Both hardware and software use permissive licences.
  • Affordability – Uses commodity microcontrollers and standard cables.
  • Compatibility – Supports many legacy formats across diverse computing platforms.
  • Community resources – Documentation, tutorials, and forums assist users in data recovery.[5]

Key People

  • Keir Fraser – Project founder and lead developer.
  • Yann Serra – Contributor of a widely used usage tutorial.
  • Community contributors via GitHub, wiki, and forums.

Appendix: Supported Disk Profiles

Greaseweazle Host Tools
DeveloperKeir Fraser
Latest release 
   1.6(28 September 2024)
Operating system
Click to show/hide full disk profile table from Yann Serra Tutorial

Adapted from the Yann Serra Tutorial, the following table lists selected supported disk profiles with geometry, encoding, and preferred suffixes.

System Profile Sides Cyls RPM kbit/s Sect/trk Bytes/sect Encoding Size (KB) Suffix
Acorn BBC acorn.adfs.320 1 80 300 250 16 256 MFM 320 .adm
Amiga amiga.amigados 2 80 300 250 11 512 AMFM 880 .adf
Atari ST atarist.720 2 80 300 250 9 512 MFM 720 .st, .msa
IBM PC ibm.1440 2 80 300 500 18 512 MFM-HD 1440 .img, .dsk
Macintosh 68K mac.800 2 80 VAR 375 12–8 512 GCR 800 .dsk
ZX Spectrum zx.trdos.640 2 80 300 250 16 256 MFM 640 .mgt, .dsk
NEC PC-98 pc98.2hs 2 81 300 500 9 1024 MFM-HD 1458 .hdm, .xdf

Full extended tables for 3.5", 5.25", 8", and 3" formats are available in the official tutorial.

References

  1. ↑ 1.0 1.1 "Greaseweazle Main Repository". GitHub. Retrieved 2025-08-11.
  2. ↑ "Greaseweazle Overview". Decromancer. Retrieved 2025-08-11.
  3. ↑ 3.0 3.1 "Greaseweazle Documentation". GitHub Wiki. Retrieved 2025-08-11.
  4. ↑ 4.0 4.1 "Yann Serra Tutorial". GitHub Wiki. Retrieved 2025-08-11.
  5. ↑ "Discussion on Greaseweazle and retrocomputing". Hacker News. Retrieved 2025-08-11.
Retrieved from "https://retrowikipedia.com/index.php?title=Greasweazle&oldid=15432"