Skip to content

Commit 13ae2c5

Browse files
committed
maybe that's all
1 parent 73a3600 commit 13ae2c5

File tree

1 file changed

+13
-56
lines changed

1 file changed

+13
-56
lines changed

README.md

Lines changed: 13 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,25 @@
66
Authentic sounds from vintage sound chips, on modern hardware!
77

88
## Introduction
9-
RetroWave is **originally** a hardware sound board series that uses vintage sound chips and works with modern hardware.
9+
RetroWave is a hardware sound board series that uses vintage sound chips and works with modern hardware.
1010

1111
They **were** in shape of Raspberry HATs, stackable, hackable, can be used on tiny single board computers like the Raspberry Pi / Jetson Nano, and modern desktop computer with USB ports.
1212

1313
Since 2022-06, the original RetroWave series are no longer produced. You can read about what happened in [this article](https://telegra.ph/What-happened-to-RetroWave-OPL3-06-21).
1414

1515
![retrowave-rip](https://user-images.githubusercontent.com/34613827/193454548-e8c173dc-f7c6-4bcd-b5ee-31df4d3ce758.jpg)
1616

17-
The successors of the original RetroWave series is called the **RetroWave Express** series. They are available in discrete boards each with its own USB port. For now, only the [RetroWave OPL3 Express](https://shop.sudomaker.com/products/retrowave-opl3-express) is available.
17+
The successors of the original RetroWave series is called the **RetroWave Express** series. They are available in discrete boards each with its own USB port. 100% software compatibility of the original RetroWave series is maintained.
18+
19+
For now, only the [RetroWave OPL3 Express](https://shop.sudomaker.com/products/retrowave-opl3-express) is available.
1820

1921
## Hardware
22+
For the information of the original RetroWave series, check the history.
23+
24+
### Features
25+
- Minimalistic form factor and convenient USB-C interface
26+
- Designed with high-grade components for everyday use
27+
- Ultra-high bandwidth provided by hardware 8080 ports
2028

2129
### Boards
2230

@@ -25,56 +33,13 @@ Available on our official [Shopify Shop](https://shop.sudomaker.com/products/ret
2533

2634
Uses the Yamaha YMF262-M chip.
2735

28-
#### OPL3
29-
No longer available, as mentioned above.
30-
31-
Uses the Yamaha YMF262-M chip.
32-
33-
![EE4A0701](https://user-images.githubusercontent.com/34613827/115404127-9b697e00-a21f-11eb-9cce-84bf7765dd9a.jpg)
34-
35-
#### Mini Blaster
36-
Under development.
37-
38-
#### MasterGear
39-
Under development.
4036

4137
... And there will be more ... are there?
4238

43-
### Features
44-
- High quality components
45-
- In shape of a Raspberry HAT
46-
- Uses SPI, a modern high-speed bus
47-
- All control pins & chip registers are directly accessible by software
48-
- Built-in crystal oscillator, no need to use an MCU
49-
- Different RetroWave boards can be stacked together, and they use the same pins
50-
- With a PotatoPi Lite as a USB adapter, the boards can be accessed via 12Mbps full speed USB CDC
51-
52-
### In depth look
53-
54-
#### Architecture
55-
There are no abstraction between software and hardware at all.
56-
57-
A simple SPI IO expander is used, and all pins of the sound chips can be controlled by software directly.
58-
59-
With the PotatoPi Lite as USB adapter, you still have the ability to control all the pins directly. Since it just acts as simple "Serial to SPI" converter.
60-
61-
All boards have built-in crystal oscillators. For sound chips that can be used with different clock speeds, programmable oscillators will be used.
62-
63-
#### Pin allocation
64-
Each board uses the same pins on the 40 pin Raspberry header (physical pin numbering):
65-
- 5V (pin 2 and 4)
66-
- All GND pins (pin 6, 9, 14, 20, 25, 30, 24, 39)
67-
- SPI MOSI (pin 19)
68-
- SPI MISO (pin 21)
69-
- SPI CLK (pin 23)
70-
- GPIO6 (pin 31)
71-
72-
Yes, the boards are stackable. And yes, different boards can function at the same time.
73-
7439
## Software
75-
We provide a library for accessing the boards, a reference command-line VGM player that uses the library, and a modified DOSBox-X that supports using RetroWave boards for sound output.
40+
The RetroWave OPL3 (Express) is supported by [DOSBox-X](https://dosbox-x.com/). The support is also ported to 86Box [by community](https://github.com/daemon32/86Box/).
7641

77-
The firmware of the USB Adapter is also open sourced: See [here](https://github.com/SudoMaker/RetroWave_USB_Adapter).
42+
For experienced users, we provide a library for accessing the boards, a reference command-line VGM player that uses the library.
7843

7944
All of them are free software.
8045

@@ -137,18 +102,10 @@ If you are good at Windows APIs, feel free to create a pull request!
137102

138103
The conhost.exe terminal is extremely laggy when repainting the whole console window. So, OSD refresh rate is set to 1 second and regmap visualization is disabled by default on Windows. If you want to see the register map visualization properly, try using MinTTY as your terminal.
139104

140-
### DOSBox-X
141-
![Screenshot_20210420_004920](https://user-images.githubusercontent.com/34613827/115405808-2a2aca80-a221-11eb-8a16-93d76cd51b71.png)
142-
143-
Currently only OPL3 is supported.
144-
145-
For the source files, see [here](https://github.com/SudoMaker/dosbox-x).
146-
147-
Supports accessing the boards using serial port (on a desktop computer) and SPI (on a Linux SBC).
148105

149106
## Licensing
150107
### Hardware
151-
All hardware designs (C) 2021 SudoMaker, All rights reserved.
108+
All hardware designs (C) 2021-2022 SudoMaker, All rights reserved.
152109

153110
### Software
154111
All source code files in this repo are free software and use the AGPLv3 license.

0 commit comments

Comments
 (0)