The-Homebrew-Cloud/SummerCart64
2
0
Fork 0
mirror of https://github.com/Polprzewodnikowy/SummerCart64.git synced 2024-11-21 21:49:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

[SC64][DOCS] Update 06_build_guide.md (#52)

Browse Source 
Make it more obvious that you need the repo when programming (and some
other minor improvements).

---------

Co-authored-by: Mateusz Faderewski <sc@mateuszfaderewski.pl>
Co-authored-by: Mateusz Faderewski <polprzewodnikowy@gmail.com>
This commit is contained in:
Robin Jones 2023-12-14 18:07:52 +00:00 committed by GitHub
parent fe855c31ae
commit e0198083ae
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 36 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
docs/06_build_guide.md
View File

@ -66,38 +66,48 @@ You can skip this step if PCB assembly service was used in previous steps.
**Please read the following instructions carefully before proceeding with programming.** **Please read the following instructions carefully before proceeding with programming.**
For initial programming you are going to need a PC and a USB to UART (serial) adapter (3.3V signaling is required, e.g. TTL-232R-3V3). ***Note:*** This guide assumes you are using Windows 10 or above.
These steps assume you are using modern Windows OS (version 10 or higher).
As for software, here's list of required applications: You will require the following hardware:
- [FT_PROG](https://ftdichip.com/utilities/#ft_prog) - FTDI FT232H EEPROM programming software - A PC running Windows 10 or above (any Linux distro should also work but programming FT232H EEPROM is arguably trickier without an official app).
- [Python 3](https://www.python.org/downloads/) with `pip3` - necessary for initial programming script: `primer.py` (windows install: check option add python to PATH) - A USB to UART (serial) adapter (with 3.3V signaling is required, e.g. TTL-232R-3V3).
Programming must be done in specific order for `primer.py` script to work correctly. You will require the following applications and packages:
- [FT_PROG](https://ftdichip.com/utilities/#ft_prog) - FTDI FT232H EEPROM programming software.
- [Python 3](https://www.python.org/downloads/) with `pip3` - necessary for initial programming script: `primer.py` (Windows install: check option add python to PATH).
- [`sc64-extra-{version}.zip`](https://github.com/Polprzewodnikowy/SummerCart64/releases) - programming scripts and firmware files, download the latest version.
First, program FT232H EEPROM: **Programming must be done in specific order for `primer.py` script to work correctly.**
1. Connect SC64 board to the PC with USB-C cable
2. Locate FT232H EEPROM template `ft232h_config.xml` Preparations:
3. Launch `FT_PROG` software 1. Install FT_PROG.
4. Click on `Scan and parse` if no device has shown up 2. Install Python 3.
5. Right click on SC64 device and choose `Apply Template -> From File` 3. Unpack `sc64-extra-{version}.zip` into a folder.
6. Select previously located `ft232h_config.xml` 4. Open terminal and navigate to the folder you've unpacked SC64 files.
7. Right click on SC64 device and choose `Program Device`
First, program the ***FT232H EEPROM***:
1. Connect the SC64 board to your PC with a USB-C cable.
2. Locate FT232H EEPROM template `ft232h_config.xml` from the `fw/ftdi/` directory.
3. Launch `FT_PROG` software.
4. Click on `Scan and parse` if no device has shown up.
5. Right click on SC64 device and choose `Apply Template -> From File`.
6. Select previously located `ft232h_config.xml`.
7. Right click on SC64 device and choose `Program Device`.
Your SC64 should be ready for next programming step. Your SC64 should be ready for next programming step.
Second, program FPGA, microcontroller and bootloader: Second, program ***FPGA, microcontroller and bootloader***:
1. Disconnect SC64 board from power (unplug USB-C cable) 1. Disconnect SC64 board from power (unplug USB-C cable).
2. Connect serial UART/TTL adapter to `TX/RX/GND` pads marked on the PCB. Cross connection TX -> RX, RX -> TX! 2. Connect serial UART/TTL adapter to `TX/RX/GND` pads marked on the PCB. Cross connection `TX -> RX`, `RX -> TX`!
3. Connect serial adapter to the PC 3. Connect serial adapter to the PC.
4. Check in device manager which port number `COMx` is assigned to serial adapter 4. Check in device manager which port number `COMx` is assigned to serial adapter.
5. Connect SC64 board to the PC with USB-C cable (***IMPORTANT:*** connect it to the same computer as serial adapter) 5. Connect SC64 board to the PC with USB-C cable (***IMPORTANT:*** connect it to the same computer as serial adapter).
6. Locate `primer.py` script in root folder 6. Locate `primer.py` script in the root folder.
7. Make sure these files are located in the same folder as `primer.py` script: `requirements.txt`, `sc64-firmware-{version}.bin` 7. Make sure these files are located in the same folder as `primer.py` script: `requirements.txt`, `sc64-firmware-{version}.bin`.
8. Run `pip3 install -r requirements.txt` to install required python packages 8. Run `pip3 install -r requirements.txt` in the terminal to install required python packages.
9. Run `python3 primer.py COMx sc64-firmware-{version}.bin` (replace `COMx` with port located in step **4**). On Windows it's python instead of python3. 9. Run `python3 primer.py COMx sc64-firmware-{version}.bin` (replace `COMx` with port located in step **4**). On Windows it's `python` instead of `python3`.
10. Follow the instructions on the screen 10. Follow the instructions on the screen.
11. Wait until programming process has finished (**DO NOT STOP PROGRAMMING PROCESS OR DISCONNECT SC64 BOARD FROM PC**, doing so might irrecoverably break programming through UART header and you would need to program FPGA and/or microcontroller with separate dedicated programming interfaces through *Tag-Connect* connector on the PCB) 11. Wait until programming process has finished (**DO NOT STOP PROGRAMMING PROCESS OR DISCONNECT SC64 BOARD FROM PC**, doing so might irrecoverably break programming through UART header and you would need to program FPGA and/or microcontroller with separate dedicated programming interfaces through *Tag-Connect* connector on the PCB).
Congratulations! Your SC64 flashcart should be ready for use! Congratulations! Your SC64 flashcart should be ready for use!