# MiSTeryNano

The MiSTeryNano is a port of the
[MiSTery Atari STE FPGA core](https://github.com/gyurco/MiSTery) to the
[Tang series of FPGA boards](https://wiki.sipeed.com/hardware/en/tang/index.html)
like the [Tang Nano 20k FPGA board](https://wiki.sipeed.com/nano20k). Recently support
for the [Efinix T20](https://www.efinixinc.com/shop/t20.php) has been added.

MiSTeryNano implements the hardware of an [Atari ST](https://de.wikipedia.org/wiki/Atari_ST) allowing it to
run the original operating systems as well as the majority of games and
productivity software of the [Atari ST](https://de.wikipedia.org/wiki/Atari_ST).

A complete MiSTeryNano setup also requires a supporting MCU acting as
the [FPGA Companion](https://github.com/MiSTle-Dev/FPGA-Companion/).

For support and more information please visit the [Atari forum](https://www.atari-forum.com/viewtopic.php?p=457209).

![MiSTeryNano photo](images/misterynano.jpeg)

## Current state

The MiSTeryNano's current features are:

  * Atari ST/STE
    * Complete Atari ST/E chipset
    * ST or STE configurable
    * Cycle exact 8 MHz 68000 CPU
    * 4MB RAM, optional 8MB STRAM
    * color and monochrome video via HDMI
    * YM2149 and STE DMA sound via HDMI
    * Blitter
  * Supports most TOS versions
  * Full IKBD implementation
    * Mapped to USB via [FPGA Companion](https://github.com/MiSTle-Dev/FPGA-Companion/)
    * Mouse and keyboard via USB
    * Joystick via USB or dedicated IO pins of Tang Nano 20k
  * Floppy disk images
    * Read and write support for drive A: and drive B:
    * Images stored in .ST format on regular FAT/exFAT formatted SD card
  * ACSI harddisks
    * Read and write support for ACSI 0 and 1
    * Tested with AHDI, PP's driver and HDDriver 12.03
    * Images stored in .HD format
  * MIDI
    * Physical MIDI-IN and OUT
  * Optional custom carrier board like the [MiSTeryShield20k](https://github.com/MiSTle-Dev/Boards/tree/main/misteryshield20k/) or [MiSTeryShield20k RPiPico](https://github.com/MiSTle-Dev/Boards/tree/main/misteryshield20k_rpipico)
  * [Optional case](https://github.com/prcoder-1/MiSTeryNano-Case)
  * Runs on various Tang variants
    * [Tang Nano 20k](https://wiki.sipeed.com/nano20k)
    * [Tang Primer 25k](TANG_PRIMER_25K.md)
    * [Tang Mega 138k Pro](TANG_MEGA_138K.md)
    * [Tang Console 60k/138k](TANG_CONSOLE_60K.md)	
    * [Efinix T20BGA256](src/efinix/t20_bga256/README.md)
  * Supports different MCUs for the [FPGA Companion](https://github.com/MiSTle-Dev/FPGA-Companion/)
    * [integrated onboard BL616 MPU](https://github.com/MiSTle-Dev/FPGA-Companion/tree/main/src/bl616)
    * [M0S Dock/BL616](https://github.com/MiSTle-Dev/FPGA-Companion/tree/main/src/bl616)
    * [Raspberry Pi Pico/RP2040](https://github.com/MiSTle-Dev/FPGA-Companion/tree/main/src/rp2040)
    * [ESP32-S2 and S3](https://github.com/MiSTle-Dev/FPGA-Companion/tree/main/src/esp32)

## Videos

These videos primarily document the progress during development:
  * [MiSTeryNano #23: Going online as if it's 1990](https://www.youtube.com/shorts/LzfyftSwXaw)
  * [MiSTeryNano #22: Running Atari ST demo on Efinix Trion T20 FPGA](https://youtube.com/shorts/_95nhmBHSxg)
  * [MiSTeryNano #21: I built a half sized keyboard for my FPGA Atari ST](https://youtube.com/shorts/clQujxjdr9I)

<details><summary>More ...</summary>
<ul>
  <li><a href="https://youtube.com/shorts/i-hUT1_UNOY">MiSTeryNano #20: Atari STE on Tang Primer 25k FPGA</a></li>
  <li><a href="https://youtube.com/shorts/CI1L_LBodlw">MiSTeryNano #19: Atari STE Stardust on Tang Mega 138K FPGA</a></li>
  <li><a href="https://youtube.com/shorts/_D7Gc8IL2GA">MiSTeryNano #18: Cheap RGB LCD for Atari ST in FPGA
  <li><a href="https://youtube.com/shorts/qh_TCCgo1xY">MiSTeryNano #17: C64 on Tang Nano 20K</a></li>
  <li><a href="https://youtube.com/shorts/IOfeoJvnrmE">MiSTeryNano #16: Atari ST MIDI Space Quest 3 on Roland MT32</a></li>
  <li><a href="https://youtube.com/shorts/-kPpSlpkzvA">MiSTeryNano #15: Power Without the Price: The Tang Nano 20k is the cheapest Atari ST</a></li>
  <li><a href="https://youtube.com/shorts/w8RZCzeMpiw">MiSTeryNano #14: Cubase MIDI audio replay with Atari ST FPGA and SAM2695</a></li>
  <li><a href="https://youtube.com/shorts/o6ABtje7zZ8">MiSTeryNano #13: Atari ST in Tang Nano 20k FPGA running Cubase 3 from Harddisk image</a></li>
  <li><a href="https://youtube.com/shorts/UPiLkYA_o0o">MiSTeryNano #12: Atari ST first boot from virtual hard disk</a></li>
  <li><a href="https://youtube.com/shorts/NP1EnRj4Fk0">MiSTeryNano #11: Advanced SD card for FPGA Atari ST</a></li>
  <li><a href="https://youtube.com/shorts/zsHYcolqtpc">MiSTeryNano #10: New OSD for the FPGA Atari ST</a></li>
  <li><a href="https://youtube.com/shorts/bP5gK3nmv-o">MiSTeryNano #9: Tang Nano 20k as USB host</a></li>
  <li><a href="https://youtube.com/shorts/jjps1x1NjhE">MiSTeryNano #8: Atari ST with USB keyboard and touchpad</a></li>
  <li><a href="https://youtube.com/shorts/Ud1P1vE5j84">MiSTeryNano #7: Tang Nano 20k running Atari ST Oxyd2</a></li>
  <li><a href="https://youtube.com/shorts/EXPfdhlpuFI">MiSTeryNano #6: B.I.G. DEMO</a></li>
  <li><a href="https://youtube.com/shorts/xJHF-LlaHFo">MiSTeryNano #5: Playing Atari ST Frontier</a></li>
  <li><a href="https://youtube.com/shorts/FfL01D0Zg0o">MiSTeryNano #4: Drives and Blitter</a></li>
  <li><a href="https://youtube.com/shorts/9wFxQvKtOY8">MiSTeryNano #3: We got a rainbow!</a></li>
  <li><a href="https://youtube.com/shorts/yLxXRR_04UE">MiSTeryNano #2: Booting TOS 1.04 for the first time</a></li>
  <li><a href="https://youtube.com/shorts/qndojsbH9jw">MiSTeryNano #1: Is the Tang Nano 20k the cheapest and smallest Atari ST?</a></li>
</ul>
</details>

## Getting started

In order to use the MiSTeryNano the following things are needed:

  * Tang FPGA board like e.g. the [Tang Nano 20k](https://wiki.sipeed.com/nano20k) to run the MiSTeryNano core itself
  * MCU board like the [M0S Dock](https://wiki.sipeed.com/hardware/en/maixzero/m0s/m0s.html) to run the [FPGA Companion](https://github.com/MiSTle-Dev/FPGA-Companion/) to connect USB keyboard and mouse
  * Breadboard to wire everything up and some jumper wires, or
  * [a MiSTeryShield](https://github.com/MiSTle-Dev/Boards/tree/main/misteryshield20k/)
  * a USB-C to USB-A adapter to connect regular USB devices to the M0S Dock

Many other variants can be built using various Tang FPGA boards and different MCUs. 

![MiSTeryNano breadboard](images/misterynano_bb.jpeg)

## Installation on e.g. Tang Nano 20k

The installation of MiSTeryNano on the Tang Nano 20k using can be done
using a [Linux PC](INSTALLATION_LINUX.md) or a [Windows PC](INSTALLATION_WINDOWS.md).

See the [trouble shooting guide](TROUBLESHOOTING.md) if you run into problems.

## Wiring

The properly flashed Tang Nano 20K will boot into the Atari ST desktop
even without anything else connected. But in order to use the system
you need at least a keyboard and most likely also a mouse. These are
usually connected through the M0S Dock.

Additional connections exist for a physical DB9 joystick or
Atari ST mouse and MIDI IN and OUT. The usage of these pins
is optional. They can just be left unconnected. A joystick may
then be connected via USB instead.

![MiSTeryNano wiring](images/wiring_spi_midi.png)

## Usage

The MiSTeryNano is mainly controlled through an on-screen-display (OSD)
overlaying the main Atari ST screen. The OSD is opened using the F12
key. It can then be used to select floppy and harddisk images and to
configure the running system.