https://github.com/49bitcat/nileswan
An open source WS/WSC/SC/PCv2 flash cart
https://github.com/49bitcat/nileswan
Last synced: 14 days ago
JSON representation
An open source WS/WSC/SC/PCv2 flash cart
- Host: GitHub
- URL: https://github.com/49bitcat/nileswan
- Owner: 49bitcat
- License: gpl-3.0
- Created: 2023-08-05T21:41:10.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2026-02-10T17:24:44.000Z (4 months ago)
- Last Synced: 2026-02-10T19:58:58.440Z (4 months ago)
- Language: HTML
- Homepage: https://www.49bitcat.com/docs/nileswan/
- Size: 9.56 MB
- Stars: 73
- Watchers: 12
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
- awesome-wsdev - nileswan - Open-source flash cartridge. (Hardware development / Cartridges)
README
# nileswan
Open software, WS/WSC/PCv2 compatible flash cartridge.
## Building instructions
### Requirements
- [OSS CAD Suite](https://github.com/YosysHQ/oss-cad-suite-build) (FPGA core)
- Requires a modified version of `icepack`, see below for more information
- [Wonderful Toolchain](https://wonderful.asie.pl/wiki/doku.php?id=getting_started)
- `target-wswan` (IPL1, recovery, updater)
- `toolchain-gcc-arm-none-eabi` (MCU firmware)
- `wf-superfamiconv` (IPL1)
- `wf-zx0-salvador` (IPL1, updater)
- CMake (MCU firmware)
- NASM (IPL0)
- Nim 2.0+ (FPGA core, IPL0)
- Ninja (MCU firmware)
- Python 3.x (SPI images, updater)
- Including external libraries: `crc`
- dd, dosfstools, mtools (emulator images)
#### icepack
For the FPGA to be ready in time, the bitstream needs to be as small as possible and loaded at the highest speed possible. Thus a [modified branch of icepack](https://github.com/49bitcat/icestorm/tree/nileswan) has to be used.
### Compiling
1. Make sure to fetch the Git submodules: `git submodule update --init --recursive`.
2. Run `make help` to read what build options are possible.
3. Run `make` (or `make ...`) to build the requested components.
## License
- `docs/`: [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) (user and developer documentation)
- `firmware/`: GNU GPLv3+ (MCU firmware)
- `shell/`: [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) (cartridge shell STL files)
- `software/`: GNU GPLv3+ (cartridge IPL and on-device tools)
* `software/libnile/`: zlib AND FatFs license