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][SW] Changed update file name / improved manufacturing guidelines

Browse Source
This commit is contained in:
Mateusz Faderewski 2023-02-17 11:26:50 +01:00
parent 9757a32fc0
commit ed6d01a066
5 changed files with 14 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
build.sh
View File

@ -9,7 +9,7 @@ TOP_FILES=(
"./sw/pc/primer.py" "./sw/pc/primer.py"
"./sw/pc/requirements.txt" "./sw/pc/requirements.txt"
"./sw/pc/sc64.py" "./sw/pc/sc64.py"
"./sw/update/sc64.upd" "./sw/update/sc64_update_package.bin"
) )
FILES=( FILES=(
@ -87,7 +87,7 @@ build_update () {
pushd sw/update > /dev/null pushd sw/update > /dev/null
if [ "$FORCE_CLEAN" = true ]; then if [ "$FORCE_CLEAN" = true ]; then
rm -f ./sc64.upd rm -f ./sc64_update_package.bin
fi fi
GIT_INFO="" GIT_INFO=""
if [ ! -z "${GIT_BRANCH}" ]; then GIT_INFO+="branch: [$GIT_BRANCH] "; fi if [ ! -z "${GIT_BRANCH}" ]; then GIT_INFO+="branch: [$GIT_BRANCH] "; fi
@ -101,7 +101,7 @@ build_update () {
--fpga ../../fw/project/lcmxo2/impl1/sc64_impl1.jed \ --fpga ../../fw/project/lcmxo2/impl1/sc64_impl1.jed \
--boot ../bootloader/build/bootloader.bin \ --boot ../bootloader/build/bootloader.bin \
--primer ../controller/build/primer/primer.bin \ --primer ../controller/build/primer/primer.bin \
sc64.upd sc64_update_package.bin
popd > /dev/null popd > /dev/null
BUILT_UPDATE=true BUILT_UPDATE=true

4
docs/00_quick_startup_guide.md
View File

@ -66,6 +66,6 @@ Run `python3 sc64.py --boot direct --rom path_to_rom.n64` to disable bootloader
## Firmware backup/update ## Firmware backup/update
To download and backup current version of SC64 firmware run `python3 sc64.py --backup-firmware sc64_backup.upd`. To download and backup current version of SC64 firmware run `python3 sc64.py --backup-firmware sc64_backup_package.bin`.
To update SC64 firmware run `python3 sc64.py --update-firmware sc64.upd` To update SC64 firmware run `python3 sc64.py --update-firmware sc64_update_package.bin`

16
docs/06_manufacturing_guidelines.md
View File

@ -61,7 +61,7 @@ For initial programming you are going to need a PC and a USB to UART (serial) ad
As for software here's list of required applications: As for software here's list of required applications:
- [FT_PROG](https://ftdichip.com/utilities/#ft_prog) - FTDI FT232H EEPROM programming software - [FT_PROG](https://ftdichip.com/utilities/#ft_prog) - FTDI FT232H EEPROM programming software
- [Python 3](https://www.python.org/downloads/) - necessary for initial programming script, `primer.py` - [Python 3](https://www.python.org/downloads/) with `pip3` - necessary for initial programming script, `primer.py`
Programming must be done in specific order for `primer.py` script to work correctly. Programming must be done in specific order for `primer.py` script to work correctly.
@ -78,14 +78,14 @@ Your SC64 should be ready for next programming step.
Second, program FPGA, microcontroller and Flash memory: Second, program FPGA, microcontroller and Flash memory:
1. Disconnect SC64 board from power (unplug USB-C cable) 1. Disconnect SC64 board from power (unplug USB-C cable)
2. Connect USB to UART adapter to TX/RX/GND pads marked on the PCB 2. Connect serial adapter to `TX/RX/GND` pads marked on the PCB
3. Connect serial adapter to the PC 3. Connect serial adapter to the PC
4. Connect SC64 board to the PC with USB-C cable (**IMPORTANT:** connect it to the same computer as serial adapter) 4. Check in device manager which port number `COMx` is assigned to serial adapter
5. Check in device manager which port number (`COMx`) is assigned to serial adapter (**not SC64 port number**) 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 root folder
7. Make sure `sc64.py` and `dd64.py` scripts are located in the same folder as `primer.py` 7. Make sure these files are located in the same folder as `primer.py` script: `requirements.txt`, `sc64.py`, `dd64.py`, `sc64_update_package.bin`
8. Make sure `sc64.upd` firmware update file is located in the same folder as `primer.py` 8. Run `pip3 install -r requirements.txt` to install required python packages
9. Run `python3 primer.py COMx sc64.upd` (replace `COMx` with port located in step **5**) 9. Run `python3 primer.py COMx sc64_update_package.bin` (replace `COMx` with port located in step **4**)
10. Follow the instructions on the screen 10. Follow the instructions on the screen
11. Wait until programming process has finished 11. Wait until programming process has finished
@ -97,4 +97,4 @@ Congratulations! Your SC64 flashcart should be ready for use!
*`primer.py` threw error on `Bootloader -> SC64 FLASH` step* *`primer.py` threw error on `Bootloader -> SC64 FLASH` step*
This issue can be attributed to incorrectly programmed FT232H EPPROM in first programming step. Check again in `FT_PROG` if device was configured properly. Once FPGA and microcontroller has been programmed successfully, `primer.py` script cannot be used again. Please use command `python3 sc64.py --update-firmware sc64.upd` to try programming bootloader again. This issue can be attributed to incorrectly programmed FT232H EPPROM in first programming step. Check again in `FT_PROG` if device was configured properly. Once FPGA and microcontroller has been programmed successfully, `primer.py` script cannot be used again. Please use command `python3 sc64.py --update-firmware sc64_update_package.bin` to try programming bootloader again.

1
sw/pc/.gitignore vendored
View File

@ -4,6 +4,5 @@
*.fla *.fla
*.n64 *.n64
*.srm *.srm
*.upd
*.v64 *.v64
*.z64 *.z64

2
sw/update/.gitignore vendored
View File

@ -1 +1 @@
*.upd *.bin