2024-04-30 19:20:02 +02:00
# SummerCart64 - a fully open source N64 flashcart
2023-08-30 18:14:24 +02:00
[<img src="assets/sc64_logo.svg" /> ](assets/sc64_logo.svg )
2020-10-08 02:04:42 +02:00
2024-04-10 21:48:00 +02:00
**For non-technical description of the SummerCart64, please head to the https://summercart64.dev website!**
2024-04-10 21:45:42 +02:00
[SC64][FW][HW][SW] New version based on LCMXO2 FPGA (#19)
* isv support + usb/dd improvements
* make room for saves
* update offset
* fixed debug address
* idk
* exception
* ironed out all broken stuff
* cleanup
* return epc fix
* better
* more cleanup
* even more cleanup
* mooore cleanup
* fixed printf
* no assert
* improved docker build, pyft232 instead of pyserial
* fixed displaying long message strings
description test
* just straight cleanup
* smallest cleanup
* PAL
* cpu buffer
* n64 bootloader done
* super slow usb storage reading implemented
* reduced buffer size
* usb gets fast
* little cleanup
* double buffered reads
* removed separate event id
* ISV in hardware finally
* small exception changes
* mac testing
* py spacing
* fsd write, rtc, isv and reset fixes
* fixxx
* good stopping point
* usb fixed?
* pretend we have 128 MB sdram
* backup
* chmod
* test
* test done
* more tests
* user rm
* help
* final fix
* updated component values
* nice asset names
* cic 64dd support
* ddipl enable separation
* pre DMA rewrite, created dedicated buffer memory space, simplified code
* dma rewrite, needs testing
* moved xml
* dd basics
* timing
* 64dd working yet again, isv brought back, dma fixes, usb path rewrite, pc code rewrite
* added usb read functionality, general cleanup
* changed mem addressing
* added fpga flash update access
* added mcu update
* chmod
* little cleanup
* update format and stuff
* fixes
* uninitialized fix
* small fixes
* update fixes
* update stuff done
* fpga update tested
* build time fix
* boot fix
* test timing
* readme test
* test 2
* reports
* testseet
* final
* build test
* forgot
* button and naming
* General cleanup
And multiline commit message test
* Exception screen UI touch ups
* display separation and tests beginning
* pc software update
* pc software done
* timing test
* delete launch.json
* sw fixes
* fixed button hole diameter in shell
* small cleanup, rpi testing
* shell fillet fix, pc rtc printing
* added cfg lock mechanism
* moved lock to cfg address space
* extended ROM and ISV fixes
* preliminary sd card support
* little sd card cleanup
* sd menu fixes
* 5 second limit
* reduced shell thickness
* basic led act blinking
* faster sd menu loading
* inst cache invalidate
* sd card writing is working
* SD card CSD and CID registers
* wait for previous command
* led error codes
* fixed cfg_translate_address use
* 64dd from sd card working
* 64dd speedup and button handling
* delayed address latching cycle - might break other builds, needs testing
* bootloader improvements
* small fixes
* return previous cfg when setting new
* cache stuff
* unfloader debug protocol support
* UNFLoader style debug command line support
* requirements.txt
* shell groove fillet
* reset state inside controller
* fixed fast PI read, added PI R/W fifo debug info
* PI access prioritize
* SD clock stop when RX FIFO is more than half full
* flash erase method change
* CFG error handling, TLOZ MM debug ISV support
* CIC5167 support
* general fixes
* USB unplugged cable handling
* turn off led when changing between error/act modes
* rtc 2 bit clock stop support
* line endings
* Revert "line endings"
This reverts commit d0ddfe5ec716d2db7c72561703f51a94bf34e6bb.
* PI address debug
* readme test
* diagram update
* diagram background
* diagram background
* diagram background
* updated readme
2022-11-10 11:46:54 +01:00
## Features
2024-10-11 19:09:41 +02:00
- **ROM and Save Memory On-board**
- 64 MiB SDRAM memory for game and save data (enough memory to support every retail game without compromise)
- 16 MiB FLASH memory for bootloader and extended game data (with extended memory flashcart supports game ROMs up to 78 MiB)
- **Game Saves**
- EEPROM 4k/16k, SRAM and FlashRAM save types with an automatic writeback to the SD card (no reset button press required)
- **Hardware-Dependent Game Features**
- 64DD add-on emulation
- Battery backed real time clock (RTC)
- **Menu**
- Dedicated open source menu written specifically for this flashcart - [N64FlashcartMenu ](https://github.com/Polprzewodnikowy/N64FlashcartMenu )
- **Game Development**
- ~23.8 MiB/s peak transfer rate SD card interface
- ~23.8 MiB/s peak transfer rate USB interface for data upload/download and debug functionality
- PC app to access the flashcart features:
- Game/save data upload/download
- Feature enable control
- Debug terminal
- Access to the SD card
- Firmware update
- [UNFLoader ](https://github.com/buu342/N64-UNFLoader ) support
- IS-Viewer 64 debug interface (fixed 64 kiB buffer with a movable base address)
- 8 kiB on-chip buffer for general use
- Status LED and button for general use
- [UltraCIC_C ](https://github.com/jago85/UltraCIC_C ) emulation with automatic region switching and programmable seed/checksum values
- N64 bootloader with support for IPL3 registers spoofing and loading menu from SD card
- **Cartridge Production**
- Initial programming via UART header or via dedicated JTAG/SWD interfaces
- 3D printable shell
2020-10-08 02:04:42 +02:00
2022-12-31 02:27:11 +01:00
---
## Documentation
2023-02-09 22:50:10 +01:00
- [Quick startup guide ](./docs/00_quick_startup_guide.md )
2023-01-01 22:09:27 +01:00
- [Memory map ](./docs/01_memory_map.md )
2023-08-26 13:37:48 +02:00
- [N64 commands ](./docs/02_n64_commands.md )
- [USB interface ](./docs/03_usb_interface.md )
2023-01-01 22:09:27 +01:00
- [Config options ](./docs/04_config_options.md )
2023-08-26 13:37:48 +02:00
- [FW and SW info ](./docs/05_fw_and_sw_info.md )
- [Build guide ](./docs/06_build_guide.md )
2022-12-31 02:27:11 +01:00
---
2020-10-08 02:04:42 +02:00
2023-08-26 13:37:48 +02:00
## How do I get one?
2023-02-17 01:15:36 +01:00
2024-04-10 21:45:42 +02:00
Most up to date information about purchasing/manufacturing options is available on https://summercart64.dev website!
2023-02-17 01:15:36 +01:00
2024-04-30 19:20:02 +02:00
If you want to order it yourself then I've prepared all necessary manufacturing files on the [PCBWay Shared Project ](https://www.pcbway.com/project/member/shareproject/?bmbno=1046ED64-8AEE-44 ) site.
2023-12-14 19:26:54 +01:00
**Be careful**: this is an advanced project and it is assumed that you have enough knowledge about electronics.
Selecting wrong options or giving PCB manufacturer wrong information might result in an undesired time and/or money loss.
Boards also come unprogrammed from the manufacturer - you need to do **initial programming step** yourself after receiving the board.
2024-04-10 21:45:42 +02:00
**Price of the components is not included in the initial quote at the checkout** - manufacturer will contact you later with updated price.
2023-12-14 19:26:54 +01:00
To avoid problems _**please**_ read **both** [build guide ](./docs/06_build_guide.md ) and description on the shared project page **in full** .
2024-08-16 13:59:46 +02:00
If you have even slightest doubt about the ordering or programming process, it is better to leave it to someone experienced - ask in the [N64brew Discord server ](https://discord.gg/8VNMKhxqQn ) if that's the case.
2024-04-10 21:45:42 +02:00
2024-04-30 19:20:02 +02:00
**Full disclosure**: for every order made through [this link ](https://www.pcbway.com/project/member/shareproject/?bmbno=1046ED64-8AEE-44 ) I will receive 10% of PCB manufacturing and PCB assembly service cost (price of the components is not included in the split). This is a great way of supporting further project development.
2023-01-04 20:47:23 +01:00
2024-10-11 18:36:10 +02:00
If you don't need a physical product but still want to support me then check the sponsor links on the [official website ](https://summercart64.dev ).
2023-01-04 20:47:23 +01:00
---
[SC64][FW][HW][SW] New version based on LCMXO2 FPGA (#19)
* isv support + usb/dd improvements
* make room for saves
* update offset
* fixed debug address
* idk
* exception
* ironed out all broken stuff
* cleanup
* return epc fix
* better
* more cleanup
* even more cleanup
* mooore cleanup
* fixed printf
* no assert
* improved docker build, pyft232 instead of pyserial
* fixed displaying long message strings
description test
* just straight cleanup
* smallest cleanup
* PAL
* cpu buffer
* n64 bootloader done
* super slow usb storage reading implemented
* reduced buffer size
* usb gets fast
* little cleanup
* double buffered reads
* removed separate event id
* ISV in hardware finally
* small exception changes
* mac testing
* py spacing
* fsd write, rtc, isv and reset fixes
* fixxx
* good stopping point
* usb fixed?
* pretend we have 128 MB sdram
* backup
* chmod
* test
* test done
* more tests
* user rm
* help
* final fix
* updated component values
* nice asset names
* cic 64dd support
* ddipl enable separation
* pre DMA rewrite, created dedicated buffer memory space, simplified code
* dma rewrite, needs testing
* moved xml
* dd basics
* timing
* 64dd working yet again, isv brought back, dma fixes, usb path rewrite, pc code rewrite
* added usb read functionality, general cleanup
* changed mem addressing
* added fpga flash update access
* added mcu update
* chmod
* little cleanup
* update format and stuff
* fixes
* uninitialized fix
* small fixes
* update fixes
* update stuff done
* fpga update tested
* build time fix
* boot fix
* test timing
* readme test
* test 2
* reports
* testseet
* final
* build test
* forgot
* button and naming
* General cleanup
And multiline commit message test
* Exception screen UI touch ups
* display separation and tests beginning
* pc software update
* pc software done
* timing test
* delete launch.json
* sw fixes
* fixed button hole diameter in shell
* small cleanup, rpi testing
* shell fillet fix, pc rtc printing
* added cfg lock mechanism
* moved lock to cfg address space
* extended ROM and ISV fixes
* preliminary sd card support
* little sd card cleanup
* sd menu fixes
* 5 second limit
* reduced shell thickness
* basic led act blinking
* faster sd menu loading
* inst cache invalidate
* sd card writing is working
* SD card CSD and CID registers
* wait for previous command
* led error codes
* fixed cfg_translate_address use
* 64dd from sd card working
* 64dd speedup and button handling
* delayed address latching cycle - might break other builds, needs testing
* bootloader improvements
* small fixes
* return previous cfg when setting new
* cache stuff
* unfloader debug protocol support
* UNFLoader style debug command line support
* requirements.txt
* shell groove fillet
* reset state inside controller
* fixed fast PI read, added PI R/W fifo debug info
* PI access prioritize
* SD clock stop when RX FIFO is more than half full
* flash erase method change
* CFG error handling, TLOZ MM debug ISV support
* CIC5167 support
* general fixes
* USB unplugged cable handling
* turn off led when changing between error/act modes
* rtc 2 bit clock stop support
* line endings
* Revert "line endings"
This reverts commit d0ddfe5ec716d2db7c72561703f51a94bf34e6bb.
* PI address debug
* readme test
* diagram update
* diagram background
* diagram background
* diagram background
* updated readme
2022-11-10 11:46:54 +01:00
## High-level flashcart block diagram
2020-10-08 02:04:42 +02:00
2023-01-04 20:47:23 +01:00
[<img src="assets/sc64_block_diagram.svg" alt="SC64 block diagram" width="800" /> ](assets/sc64_block_diagram.svg )
2020-10-08 02:04:42 +02:00
2022-12-31 02:27:11 +01:00
---
2020-11-06 00:17:08 +01:00
2023-01-04 20:47:23 +01:00
## Finished example
[<img src="assets/sc64_finished_example.jpg" alt="SC64 finished example" width="800" /> ](assets/sc64_finished_example.jpg )
2023-12-14 19:26:54 +01:00
2023-08-26 13:37:48 +02:00
[<img src="assets/sc64_pcb_front.jpg" alt="SC64 PCB front" width="800" /> ](assets/sc64_pcb_front.jpg )
2023-12-14 19:26:54 +01:00
2023-08-26 13:37:48 +02:00
[<img src="assets/sc64_pcb_back.jpg" alt="SC64 PCB back" width="800" /> ](assets/sc64_pcb_back.jpg )
2023-01-04 20:47:23 +01:00
---
## Acknowledgement
This project wouldn't be possible without these contributions:
2020-11-06 00:17:08 +01:00
2024-04-30 19:20:02 +02:00
- [64drive ](https://64drive.retroactive.be ) ([archived](https://web.archive.org/web/20240406215731/https://64drive.retroactive.be/)) orders being on permanent hold long before creating this repository.
2023-01-04 20:47:23 +01:00
- [EverDrive-64 X7 ](https://krikzz.com/our-products/cartridges/ed64x7.html ) being disappointment for homebrew development (slow USB upload, unjustified price and overcomplicated SD card access).
2024-05-05 16:15:26 +02:00
- Context: Both aforementioned products were priced at $199 in 2020. 64drive features made it a vastly more useful tool for homebrew development.
Since then, 64drive had never been restocked and EverDrive-64 X7 price was lowered to $159 (as of May 2024).
2023-01-04 23:29:17 +01:00
- [Jan Goldacker (@jago85) ](https://github.com/jago85 ) and his projects:
2023-01-04 20:47:23 +01:00
- [Brutzelkarte ](https://github.com/jago85/Brutzelkarte_FPGA ) providing solid base for starting this project and sparking hope for true open source N64 flashcarts.
- [UltraCIC_C ](https://github.com/jago85/UltraCIC_C ) reimplementation for easy integration in modern microcontrollers. Thanks also goes to everyone involved in N64 CIC reverse engineering.
- [N64brew ](https://discord.gg/WqFgNWf ) Discord server community being very helpful during flashcart development.
- [FatFs ](http://elm-chan.org/fsw/ff/00index_e.html ) FAT32/exFAT library being easiest to integrate in embedded environment.
2023-01-04 23:29:17 +01:00
- [Yakumono's (@LuigiBlood) ](https://twitter.com/LuigiBlood ) extensive [64DD documentation ](https://github.com/LuigiBlood/64dd/wiki ) and its implementation in various emulators.
2023-01-04 23:31:37 +01:00
- [Libdragon ](https://github.com/DragonMinded/libdragon ) open source N64 SDK project and its developers.
2023-12-14 19:26:54 +01:00
- [SERV ](https://github.com/olofk/serv ) bit-serial 32-bit RISC-V CPU soft core.
