son1128 / pico-zxspectrum

ZX Spectrum for Raspberry Pico Pi RP2040

pico-zxspectrum

48k/128k ZX Spectrum for Raspberry Pico Pi RP2040

This is a basic 48k/128k ZX Spectrum emulation on the RP2040 with DVI/LCD/VGA output.

Features

• DVI over HDMI (Wren's Amazing PicoDVI)
• LCD support (ST7789 320x240)
• VGA video (RGB332, RGB222, RGBY1111)
• USB keyboard & Joysticks
• PS/2 keyboard
• Martix keyboard
• PWM/I2S DAC audio for ear, mic and AY-3-8912
• 12 quick save slots
• Load from .z80 snapshot files
• Read from .tap tape files
• On screen menu system
• Kempston and Sinclair joystick emulation

Supported Boards

• Breadboard
• PICOZX
• RetroVGA
• PicomputerMax
• PicomputerZX
• Pimoroni Pico DV Demo Base

Updates

• 31/08/22 - Fix multiple Z80 self-test failures
• 27/08/22 - Fix for joysticks with single xy axis
• 13/08/22 - Added support for PICOZX
• 04/08/22 - Update wiring documentation
• 26/07/22 - Better quality 48k sound for 1 pin PWM and DAC
• 23/07/22 - Added target for Pico DV board
• 23/07/22 - Audio output via PCM 5100A DAC for Pico DV board
• 23/07/22 - Moved to Pimoroni FATFS to support Pimoroni Pico DV board
• 10/07/22 - Added basic support for PS/2 keyboards

The move from Carl's no-OS-FatFS-SD-SPI-RPi-Pico to Pimoroni's FatFS was made as the SD card pins on the Pimoroni Pico DV Demo Base do not match up with the RP2040 SPI harware support. The Pimoroni library has a PIO SPI driver, which gets around the problem.

Screen shots

Targets

Pre-built binary targets can be copied directly to a Pico Pi. They can be downloaded from the links in the table below or found in the uf2 folder. Connect your Pico Pi with a USB cable, while holding down the program button:

Board	Binary
HDMI breadboard	ZxSpectrumBreadboardHdmi1PinAudio.uf2
HDMI breadboard	ZxSpectrumBreadboardHdmi2PinAudio.uf2
HDMI breadboard	ZxSpectrumBreadboardHdmi4PinAudio.uf2
VGA breadboard	ZxSpectrum4PinAudioVga1111Ps2.uf2
PICOZX	ZxSpectrumPicomputerVga222Zx.uf2
RetroVGA	ZxSpectrumPicocomputerVga.uf2
PicomputerMax	ZxSpectrumPicocomputerMax.uf2
PicomputerZX	ZxSpectrumPicocomputerZX.uf2
Pimoroni Pico DV	ZxSpectrumPicoDv.uf2
HDMI + key matrix	ZxSpectrumBreadboardHdmiKbd1PinAudio.ufs

e.g. for the HDMI breadboard wiring show above use:

cp ZxSpectrumBreadboardHdmi4PinAudio.uf2 /media/pi/RPI-RP2/

These targets are discussed in more detail in the following sections.

ZxSpectrumBreadboardHdmiNPinAudio

This is a series of targets based around my original breadboard prototype:

The targets are:

• ZxSpectrumBreadboardHdmi4PinAudio
• ZxSpectrumBreadboardHdmi2PinAudio
• ZxSpectrumBreadboardHdmi1PinAudio

They support the following:

• USB keyboard
• PS/2 keyboard
• USB joysticks
• HDMI video
• PWM sound
• SPI SD card
• Serial port debug

All of these targets share the same pinout but make different use of the 4 audio pins:

ZxSpectrum4PinAudioVga1111Ps2

This is a target similar to the HDMI prototype which uses VGA video output.

It supports the following:

• USB keyboard
• PS/2 keyboard
• USB joysticks
• VGA video (RGBY1111)
• PWM sound (4 pin)
• SPI SD card
• Serial port debug

This target uses 4 audio pins:

ZxSpectrumPicomputerVga222Zx

This is a target written for Bobricius' PICOZX

It supports:

• USB keyboard
• Keyboard martix
• USB joysticks
• VGA video (RGB222)
• PWM sound (1 pin)
• SPI SD card

Here are the pin assignments:

ZxSpectrumPicomputerVga

This is the target for Bobricius' Retro VGA board:

It supports the following:

• USB keyboard
• USB joysticks
• Matrix keyboard (6x6)
• VGA video (RGB332)
• PWM sound (1 pin)
• SPI SD card

Here are the pin assignments:

ZxSpectrumPicomputerMax & ZxSpectrumPicomputerZX

These are the targets for Bobricius' Retro PICOmputerMAX and PICOmputerZX. The targets are very similar except the LCD on the PICOmputerZX has rounded corners and needs a different menu layout.

It supports the following:

• USB keyboard
• USB joysticks
• Matrix keyboard (6x6)
• LCD video (ST7789)
• PWM sound (1 pin)
• SPI SD card

Here are the pin assignments:

ZxSpectrumPicoDv

This target matches the Pimoroni Pico DV board:

It supports the following:

• USB keyboard
• USB joysticks
• HDMI video
• I2S sound
• SPI SD card

Here are the pin assignments:

ZxSpectrumBreadboardHdmiKbd1PinAudio

This is a target similar to the HDMI prototype which uses can read from an original Spectrum keyboard matrix.

It is a work in progress.

It supports the following:

• USB keyboard
• Matrix keyboard (8x8)
• USB joysticks
• HDMI video
• PWM sound (1 pin)
• SPI SD card

Here are the pin assignments:

I don't know how the original keyboard pins were numbered but mine go from left to right with the keyboard oriented as you would type on it.

Audio pins

There are two techniques for audio output. The first is a mixture of digital sound and PWM output, which comes in three variants. The second is is using a DAC connected to the Pico using I2S.

PWM/Digital Audio

PWM audio output comes in 3 variants 1, 2 and 4 pin:

Label	1 Pin	2 Pin	4 Pin
RP AUDIO1	Buzzer & AY-3-8912 PWM	AY-3-8912 PWM	AY-3-8912 Channel A PWM
RP AUDIO2	-	Buzzer	Buzzer
RP AUDIO3	-	-	AY-3-8912 Channel B PWM
RP AUDIO4	-	-	AY-3-8912 Channel C PWM

High frequencies need to be filtered out of the PWM audio output and mixed with the Spectrum's digital audio. Here are some sample designs. Please note they are not carefully designed but made from components I found lying around. If you create a particularly nice sounding design please let me know and I will add it to the documentation.

Separating out the Spectrum buzzer from the AY-3-8912 improves the fidelity of the Spectrum beeps.

The best audio is achieved by having separate pins for the Spectrum buzzer and AY-3-8912 A,B & C channels.

The sound is actually quite good from the 4 pin filter and at some point I will do a stero version.

Designs that only have a single GPIO pin available can have the audio mixed digitally:

I2S DAC Audio

The emulation can drive a PCM5100A DAC for line out audio over I2S. It uses the RP_DAC_DATA, RP_DAC_BCLK and RP_DAC_LRCLK pin on the Pico. Currently, only tested on the Pimoroni Pico DV board.

Video output

DVI/HDMI

The following circuit shows roughly how to connect an HDMI socket; I have always used a breakout board...

...but this is what I think it boils down to:

So far, there are three supported VGA configurations, which can be found in the various build targets. They have all been designed with a combination of plagiarism and guesswork, so please let me know if you have better versions and I will update this document.

VGA RGBY 1111

Although this is the most complicated, it is my favourite as it only uses 5 pins on the Pico. The display is slightly paler than the other two versions, which is easier on the eyes.

See this CMakeLists.txt for an example configuration.

VGA RGB 222

See this CMakeLists.txt for an example configuration.

VGA RGB 332

See this CMakeLists.txt for an example configuration.

PS/2 Keyboards

The emulator targets can accept input from a PS/2 keyboard wired to RP_PS2_DATA and RP_PS2_CLK. A suggested circuit is shown below:

The resistors and Zeners are there in case the keyboard contains a pull-up resistor to 5v on either the data or clock lines; the data and clock lines are, in theory, open-collector with no pull-up.

I'm told most PS/2 keyboards can be run at 3.3v and the the extra components become redundant... but I've not tried with mine. You may find the Pico struggles to deliver enough power at 3.3v for the SD card writes and running a keyboard.

Currently there is no toggling on the lock keys (caps/num lock) and the indicator leds are not used.

Components

RetroVGA and Picomputer keyboard mappings

Trying to squeeze in all the key mappings is tricky but here is an attempt.

These are the nomal key mappings:

These are the mappings with the ALt key down.:

Shifted and numeric mappings are turned on and off using the arrow keys (up, down, left, right). QS1, QS2, ... save the emulator state to the appropriate Quick Save slot.

If there is a save in QS1 it will load after the emulator is powered-on or reset.

The SN keys load snapshots as if they are in a loop. SN loads the current snapshot, SN- load the previous snapshot and SN+ loads the next snapshot.

These are the mappings with the numeric shift on:

Alt+V sets the arrow keys to behave like a Kempston joystick, Alt+C sets the arrow keys to operate the Spectrum cursor keys.

RetroVGA kiosk mode

Kiosk mode disables the menu system and quick-save buttons. Kiosk mode is enabled by placing the following file on the SD-card:

zxspectrum/kiosk.txt

Pico pinout

Issues

The Z80 is interrupted at the end of each frame at 60hz. The original Spectrum wrote frames at 50hz, so some code runs more frequently than it used to; there is a 4Mhz CPU setting that kind of balances this up.

There is now preliminary support for Kempston & Sinclair joysticks.

A USB hub can be connected to the RP2040 allowing a keyboard and joysticks to be used with the Spectrum. The code is a bit new and I don't know how many different joysticks will be supported; if you are having trouble raise an issue and attach a HID report descriptor from your device and I will have a look at it.

To get this to work I have done some hacking and slashing in TinyUSB (sorry Ha Thach):

https://github.com/fruit-bat/tinyusb/tree/hid_micro_parser

update

Updates suggested by Ryzee119 are getting harder to merge into the latest code:

https://github.com/Ryzee119/tinyusb/tree/multi-hub

The combined efforts were here, but are now out of date:

https://github.com/fruit-bat/tinyusb/tree/hid_micro_parser_and_hub

Build

The version of TinyUSB in the Pico SDK will need to be replaced with a version containing a HID report parser and USB hub support.

Using git protocol:

cd $PICO_SDK_PATH/lib/
mv tinyusb tinyusb.orig
git clone [email protected]:fruit-bat/tinyusb.git
cd tinyusb
git checkout hid_micro_parser

...or using https protocol:

cd $PICO_SDK_PATH/lib/
mv tinyusb tinyusb.orig
git clone https://github.com/fruit-bat/tinyusb.git
cd tinyusb
git checkout hid_micro_parser

Make a folder in which to clone the required projects e.g.

mkdir ~/pico
cd ~/pico

Clone the projects from github:

Using git protocol:

git clone [email protected]:raspberrypi/pico-extras.git
git clone [email protected]:Wren6991/PicoDVI.git
git clone [email protected]:fruit-bat/pico-vga-332.git
git clone [email protected]:fruit-bat/pico-zxspectrum.git
git clone [email protected]:pimoroni/pimoroni-pico.git
git clone [email protected]:fruit-bat/pico-dvi-menu
git clone [email protected]:fruit-bat/pico-emu-utils

...or using https protocol:

git clone https://github.com/raspberrypi/pico-extras.git
git clone https://github.com/Wren6991/PicoDVI.git
git clone https://github.com/fruit-bat/pico-vga-332.git
git clone https://github.com/fruit-bat/pico-zxspectrum.git
git clone https://github.com/pimoroni/pimoroni-pico.git
git clone https://github.com/fruit-bat/pico-dvi-menu
git clone https://github.com/fruit-bat/pico-emu-utils

Edit:

pimoroni-pico/drivers/fatfs/ffconf.h

and set FF_USE_FIND to 1

#define FF_USE_FIND            1

Perform the build:

cd pico-zxspectrum
mkdir build
cd build
cmake -DPICO_COPY_TO_RAM=0 ..
make clean
make -j4

Copy the relevant version to your board:

cp ./bin/picomputer/picomputer_vga/ZxSpectrumPicomputerVga.uf2 /media/pi/RPI-RP2/

cp ./bin/picomputer/picomputer_max/ZxSpectrumPicomputerMax.uf2 /media/pi/RPI-RP2/

or

cp ./bin/breadboard_hdmi/ZxSpectrumBreadboardHdmi.uf2 /media/pi/RPI-RP2/

Prepare an SD card

The following folders need to be created on the SD card:

Folder	Contents
zxspectrum/snapshots	Put your .z80 snapshot files in here.
zxspectrum/quicksaves	Folder for quick saves.
zxspectrum/tapes	Folder for .tap tape files.

Special keys

Key	Action
AltGr	Symbol
F1	Toggle on screen menu
F3	Toggle mute
F4	Toggle the Z80 moderator. Cycles through 3.5Mhz, 4.0Mhz and unmoderated
F5	play current tape
F6	play previous tape
F7	play next tape
F8	Reload current snap
F9	previous snap
F10	next snap
F11	Reset as 48k Spectrum
F12	Reset as 128k Spectrum
LCtrl + F1-F12	Quick save (LCtrl+F1 = save slot 1, LCtrl+F2 = save slot 2, etc)
LAlt + F1-F12	Quick load (LAlt+F1 = load slot 1, LAlt+F2 = load slot 2, etc)

Missing features

• Audio input

Debug

Pico pin	Pico GPIO	Adapter wire
1	GP0	White
2	GP1	Green
3	GND	Black

tio -m ODELBS /dev/ttyUSB0

Thanks to

CarlK for the super no OS FAT FS for Pico
Damien G for maintaining and publishing some wonderful 8-bit fonts
Wren for the amazing PicoDVI
hathach for the embeded USB library TinyUSB
Lin Ke-Fong for the Z80 emulator
Pimoroni for lots of useful libraries

References

Z80 Test suite
Wren's Amazing PicoDVI
Z80 file format documentation
Fonts by DamienG
breakintoprogram - Screen memory layout
breakintoprogram - keyboard layout
breakintoprogram - interrupts
worldofspectrum - 48k ZX Spectrum reference
worldofspectrum - 128k ZX Spectrum reference
worldofspectrum - AY-3-8912 reference
JGH Spectrum ROM
48k ZX Spectrum service manual
GOSH ZX Spectrum ROM
Cassette input circuit design
ZX Spectrum ROM Images
AY-3-8912 - manual
AY-3-8912 - synth
USB HID 1.1
ST7789 LCD driver reference
RGB for 128k ZX Spectrum
PS/2 vs HID keyboard codes
PCM 5100A DAC
RP2040 Datasheet
Z80 Instruction set with XYH
Z80 Instruction set