added build_firmware_uf2 workflow, build_and_upload.py improvements

build_and_upload.py:
- --jobs option, to override/disable parallel make jobs
- fixed `no_upload` to not require pyserial/serial packages
- fixed a newline being included in the firmware filename

Author: garthgillespie

.github/workflows/build_firmware_uf2.yml

@@ -0,0 +1,67 @@
+# this follows "Building on Linux for RP2350" in README.md
+
+name: Build Firmware (.uf2)
+
+on:
+  workflow_dispatch:
+    inputs:
+      micropython-repo:
+        description: 'repo to clone as mp-thumby'
+        required: true
+        default: TinyCircuits/micropython
+        type: string
+      micropython-ref:
+        description: 'commit to checkout in mp-thumby'
+        required: true
+        default: engine
+        type: string
+
+jobs:
+  build_firmware_uf2:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Install build chain dependencies (steps 1-2)
+        # https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf#page=33
+        run: |
+          # sudo apt update
+          sudo apt install -y git python3 cmake gcc-arm-none-eabi libnewlib-arm-none-eabi build-essential g++ libstdc++-arm-none-eabi-newlib
+
+      - name: Clone TinyCircuits MicroPython (steps 3-6)
+        uses: actions/checkout@v4
+        with:
+          repository: ${{ inputs.micropython-repo }}
+          path: mp-thumby
+          ref: ${{ inputs.micropython-ref }}
+          submodules: recursive
+
+      - name: Switch engine repo to current commit
+        uses: actions/checkout@v4
+        with:
+          path: mp-thumby/TinyCircuits-Tiny-Game-Engine
+          submodules: recursive
+
+      - name: Setup cross compiler (steps 7-8)
+        run: |
+          cd mp-thumby/mpy-cross
+          make
+
+      - name: Setup rp2 port (steps 9-10)
+        run: |
+          cd mp-thumby/ports/rp2
+          make submodules
+          # make clean
+
+      - name: Run the custom Python build script (11-12)
+        # disabling parallel jobs, because i regularly saw a race that resulted
+        # in pwm.pio.h not being generated in time -gg
+        run: |
+          cd mp-thumby/TinyCircuits-Tiny-Game-Engine
+          python3 -m pip install psutil
+          python3 build_and_upload.py -j1 no_upload
+
+      - name: Create firmware artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: firmware (.uf2)
+          path: mp-thumby/ports/rp2/build-THUMBY_COLOR/firmware_*.uf2
+          if-no-files-found: error

README.md

@@ -37,7 +37,7 @@ The engine has been tested on and ported to the following platforms:
 # Building on Linux for RP2350
 1. Update package list: `sudo apt update`
 2. Install build chain dependencies (https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf#page=33): `sudo apt install git python3 cmake gcc-arm-none-eabi libnewlib-arm-none-eabi build-essential g++ libstdc++-arm-none-eabi-newlib`
-3. Clone TinyCircuits MicroPython: `git https://github.com/TinyCircuits/micropython.git mp-thumby`
+3. Clone TinyCircuits MicroPython: `git clone https://github.com/TinyCircuits/micropython.git mp-thumby`
 4. `cd` into MicroPython: `cd mp-thumby`
 5. Checkout engine branch: `git checkout engine`
 6. Init the engine submodule: `git submodule update --init --recursive`

build_and_upload.py

@@ -6,13 +6,9 @@
 import psutil
 import subprocess
 import datetime
+import argparse
 from subprocess import Popen, PIPE, CalledProcessError
 
-# python -m pip install pyserial
-# python -m pip install serial
-import serial
-import serial.tools.list_ports
-
 
 # Helper for running commands and processing output
 def execute(cmd):
@@ -37,20 +33,26 @@ def get_drives():
 
 
 # ### Step 1: Get arguments
-arguments = sys.argv[1:]
-upload = True
-
-if len(arguments) > 0 and arguments[0] == "clean":
+parser = argparse.ArgumentParser()
+parser.add_argument('-j', '--jobs', type=int, default=8, help='(default: 8) simultaneous jobs (passed to make)')
+parser.add_argument('mode', choices=['default', 'no_upload', 'clean'], default='default')
+args = parser.parse_args()
+
+if args.mode == 'default':
+    upload = True
+elif args.mode == 'no_upload':
+    upload = False
+elif args.mode == 'clean':
     execute(['make', '-C', '../ports/rp2', 'clean', 'BOARD=THUMBY_COLOR'])
     print("\n\nSUCCESS: Done cleaning rp2 port!\n")
     exit(1)
-elif len(arguments) > 0 and arguments[0] == "no_upload":
-    upload = False
+else:
+    assert False, f'unknown mode {args.mode}' # argparse should have caught this
 
 
 # ### Step 2: Get the date of the last commit and bake into firmware
 firmware_date_file = open("src/firmware_date.h", "w")
-commit_id   = os.popen('git rev-parse --short HEAD').read()
+commit_id   = os.popen('git rev-parse --short HEAD').read().strip()
 commit_date = os.popen('git log -1 --format="%cd" --date=iso').read()
 commit_date = commit_date.splitlines()
 commit_date = commit_date[0]
@@ -68,7 +70,7 @@ def get_drives():
 
 # ### Step 3: Build the firmware (which will freeze everything in `modules`)
 print("\n\nBuilding rp2 port...\n")
-execute(['make', '-C', '../ports/rp2', '-j8', 'BOARD=THUMBY_COLOR', 'USER_C_MODULES=../../TinyCircuits-Tiny-Game-Engine/src/micropython.cmake'])
+execute(['make', '-C', '../ports/rp2', f'-j{args.jobs}', 'BOARD=THUMBY_COLOR', 'USER_C_MODULES=../../TinyCircuits-Tiny-Game-Engine/src/micropython.cmake'])
 print("\n\nDone building rp2 port!\n")
 
 # Rename UF2 if want to
@@ -88,6 +90,12 @@ def get_drives():
 if(upload is False):
     exit(0)
 
+
+# python -m pip install pyserial
+# python -m pip install serial
+import serial
+import serial.tools.list_ports
+
 # ### Step 5: Assume that the port is plugged in and may be running a program, connect to it
 #             end program with ctrl-c, and put into BOOTLOADER mode for upload
 print("Looking for serial port to reset...")