sporq/kmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #41 from KMKfw/topic-improve-build-process

Browse Source 
Improve Makefile: Stop clobbering /vendor, detect submodule changes more intelligently
This commit is contained in:
Josh Klar 2018-10-05 21:41:36 -07:00 committed by GitHub
commit b6cc0276cd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 83 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
.circleci/config.yml
View File

@ -37,6 +37,7 @@ jobs:
- v1-kmk-venv-{{ checksum "Pipfile.lock" }} - v1-kmk-venv-{{ checksum "Pipfile.lock" }}
- run: pip install pipenv==2018.7.1 - run: pip install pipenv==2018.7.1
- run: apt-get update && apt-get install -y gcc-arm-none-eabi gettext wget unzip rsync
- run: make test - run: make test
build_pyboard: build_pyboard:
@ -54,7 +55,7 @@ jobs:
- v1-kmk-venv-{{ checksum "Pipfile.lock" }} - v1-kmk-venv-{{ checksum "Pipfile.lock" }}
- run: pip install pipenv==2018.7.1 - run: pip install pipenv==2018.7.1
- run: apt-get update && apt-get install -y gcc-arm-none-eabi gettext wget unzip - run: apt-get update && apt-get install -y gcc-arm-none-eabi gettext wget unzip rsync
- run: make SKIP_KEYMAP_VALIDATION=1 USER_KEYMAP=user_keymaps/noop.py build-pyboard - run: make SKIP_KEYMAP_VALIDATION=1 USER_KEYMAP=user_keymaps/noop.py build-pyboard
@ -73,7 +74,7 @@ jobs:
- v1-kmk-venv-{{ checksum "Pipfile.lock" }} - v1-kmk-venv-{{ checksum "Pipfile.lock" }}
- run: pip install pipenv==2018.7.1 - run: pip install pipenv==2018.7.1
- run: apt-get update && apt-get install -y gcc-arm-none-eabi gettext wget unzip - run: apt-get update && apt-get install -y gcc-arm-none-eabi gettext wget unzip rsync
- run: make USER_KEYMAP=user_keymaps/noop.py build-teensy-3.1 - run: make USER_KEYMAP=user_keymaps/noop.py build-teensy-3.1

137
Makefile
View File

@ -3,22 +3,30 @@
circuitpy-deps \ circuitpy-deps \
circuitpy-freeze-kmk-nrf \ circuitpy-freeze-kmk-nrf \
devdeps \ devdeps \
freeze-nrf-vendor-deps \ freeze-nrf-build-deps \
lint lint
AMPY_PORT ?= /dev/ttyUSB0 AMPY_PORT ?= /dev/ttyUSB0
AMPY_BAUD ?= 115200 AMPY_BAUD ?= 115200
AMPY_DELAY ?= 1.5 AMPY_DELAY ?= 1.5
ARDUINO ?= /usr/share/arduino ARDUINO ?= /usr/share/arduino
PIPENV ?= $(shell which pipenv)
devdeps: Pipfile.lock devdeps: Pipfile.lock
@pipenv install --dev --ignore-pipfile @$(PIPENV) install --dev --ignore-pipfile
lint: devdeps lint: devdeps
@pipenv run flake8 @$(PIPENV) run flake8
fix-isort: devdeps fix-isort: devdeps
@find kmk/ user_keymaps/ -name "*.py" | xargs pipenv run isort @find kmk/ user_keymaps/ -name "*.py" | xargs $(PIPENV) run isort
clean:
rm -rf .submodules .circuitpy-deps .micropython-deps build
powerwash: clean
rm -rf vendor
$(PIPENV) --rm
test: micropython-build-unix test: micropython-build-unix
@echo "===> Testing keymap_sanity_check.py script" @echo "===> Testing keymap_sanity_check.py script"
@ -32,102 +40,103 @@ test: micropython-build-unix
@MICROPYPATH=tests/test_data:./ ./bin/micropython.sh bin/keymap_sanity_check.py keymaps/duplicate_row_pins.py 2>/dev/null && exit 1 || exit 0 @MICROPYPATH=tests/test_data:./ ./bin/micropython.sh bin/keymap_sanity_check.py keymaps/duplicate_row_pins.py 2>/dev/null && exit 1 || exit 0
@echo "===> The sanity checker is sane, unlike klardotsh" @echo "===> The sanity checker is sane, unlike klardotsh"
.submodules: .gitmodules .submodules: .gitmodules submodules.toml
@echo "===> Pulling dependencies, this may take several minutes" @echo "===> Pulling dependencies, this may take several minutes"
@git submodule update --init --recursive @git submodule update --init --recursive
@rsync -avh vendor/ build/
@touch .submodules @touch .submodules
.circuitpy-deps: .submodules .circuitpy-deps: .submodules
@echo "===> Building circuitpython/mpy-cross" @echo "===> Building circuitpython/mpy-cross"
@make -C vendor/circuitpython/mpy-cross @make -C build/circuitpython/mpy-cross
@echo "===> Pulling Nordic BLE stack" @echo "===> Pulling Nordic BLE stack"
@cd vendor/circuitpython/ports/nrf && ./drivers/bluetooth/download_ble_stack.sh 2>/dev/null >/dev/null @cd build/circuitpython/ports/nrf && ./drivers/bluetooth/download_ble_stack.sh 2>/dev/null >/dev/null
@touch .circuitpy-deps @touch .circuitpy-deps
.micropython-deps: .submodules .micropython-deps: .submodules
@echo "===> Building micropython/mpy-cross" @echo "===> Building micropython/mpy-cross"
@make -C vendor/micropython/mpy-cross @make -C build/micropython/mpy-cross
@touch .micropython-deps @touch .micropython-deps
submodules: .submodules
circuitpy-deps: .circuitpy-deps circuitpy-deps: .circuitpy-deps
micropython-deps: .micropython-deps micropython-deps: .micropython-deps
vendor/micropython/ports/unix/micropython: micropython-deps vendor/micropython/ports/unix/modules/.kmk_frozen build/micropython/ports/unix/micropython: micropython-deps build/micropython/ports/unix/modules/.kmk_frozen
@make -j4 -C vendor/micropython/ports/unix @make -j4 -C build/micropython/ports/unix
micropython-build-unix: vendor/micropython/ports/unix/micropython micropython-build-unix: build/micropython/ports/unix/micropython
freeze-nrf-vendor-deps: vendor/circuitpython/ports/nrf/freeze/.kmk_frozen freeze-nrf-build-deps: build/circuitpython/ports/nrf/freeze/.kmk_frozen
freeze-teensy3.1-vendor-deps: vendor/micropython/ports/teensy/freeze/.kmk_frozen freeze-teensy3.1-build-deps: build/micropython/ports/teensy/freeze/.kmk_frozen
freeze-stm32-vendor-deps: vendor/micropython/ports/stm32/freeze/.kmk_frozen freeze-stm32-build-deps: build/micropython/ports/stm32/freeze/.kmk_frozen
vendor/micropython/ports/unix/modules/.kmk_frozen: upy-freeze.txt build/micropython/ports/unix/modules/.kmk_frozen: upy-freeze.txt
@echo "===> Preparing vendored dependencies for local development" @echo "===> Preparing builded dependencies for local development"
@rm -rf vendor/micropython/ports/unix/freeze/* @rm -rf build/micropython/ports/unix/freeze/*
@cat $< | xargs -I '{}' cp -a {} vendor/micropython/ports/unix/modules/ @cat $< | xargs -I '{}' cp -a {} build/micropython/ports/unix/modules/
@touch $@ @touch $@
vendor/circuitpython/ports/nrf/freeze/.kmk_frozen: upy-freeze.txt build/circuitpython/ports/nrf/freeze/.kmk_frozen: upy-freeze.txt
@echo "===> Preparing vendored dependencies for bundling" @echo "===> Preparing builded dependencies for bundling"
@rm -rf vendor/circuitpython/ports/nrf/freeze/* @rm -rf build/circuitpython/ports/nrf/freeze/*
@cat $< | xargs -I '{}' cp -a {} vendor/circuitpython/ports/nrf/freeze/ @cat $< | xargs -I '{}' cp -a {} build/circuitpython/ports/nrf/freeze/
@touch $@ @touch $@
vendor/micropython/ports/teensy/freeze/.kmk_frozen: upy-freeze.txt build/micropython/ports/teensy/freeze/.kmk_frozen: upy-freeze.txt
@echo "===> Preparing vendored dependencies for bundling" @echo "===> Preparing builded dependencies for bundling"
@mkdir -p vendor/micropython/ports/teensy/freeze/ @mkdir -p build/micropython/ports/teensy/freeze/
@rm -rf vendor/micropython/ports/teensy/freeze/* @rm -rf build/micropython/ports/teensy/freeze/*
@cat $< | xargs -I '{}' cp -a {} vendor/micropython/ports/teensy/freeze/ @cat $< | xargs -I '{}' cp -a {} build/micropython/ports/teensy/freeze/
@touch $@ @touch $@
vendor/micropython/ports/stm32/freeze/.kmk_frozen: upy-freeze.txt build/micropython/ports/stm32/freeze/.kmk_frozen: upy-freeze.txt
@echo "===> Preparing vendored dependencies for bundling" @echo "===> Preparing builded dependencies for bundling"
@mkdir -p vendor/micropython/ports/stm32/freeze/ @mkdir -p build/micropython/ports/stm32/freeze/
@rm -rf vendor/micropython/ports/stm32/freeze/* @rm -rf build/micropython/ports/stm32/freeze/*
@cat $< | xargs -I '{}' cp -a {} vendor/micropython/ports/stm32/freeze/ @cat $< | xargs -I '{}' cp -a {} build/micropython/ports/stm32/freeze/
@touch $@ @touch $@
circuitpy-freeze-kmk-nrf: freeze-nrf-vendor-deps circuitpy-freeze-kmk-nrf: freeze-nrf-build-deps
@echo "===> Preparing KMK source for bundling into CircuitPython" @echo "===> Preparing KMK source for bundling into CircuitPython"
@rm -rf vendor/circuitpython/ports/nrf/kmk* @rm -rf build/circuitpython/ports/nrf/kmk*
@cp -av kmk vendor/circuitpython/ports/nrf/freeze/ @cp -av kmk build/circuitpython/ports/nrf/freeze/
micropython-freeze-kmk-teensy3.1: freeze-teensy3.1-vendor-deps micropython-freeze-kmk-teensy3.1: freeze-teensy3.1-build-deps
@echo "===> Preparing KMK source for bundling into MicroPython" @echo "===> Preparing KMK source for bundling into MicroPython"
@rm -rf vendor/micropython/ports/teensy/kmk* @rm -rf build/micropython/ports/teensy/kmk*
@cp -av kmk vendor/micropython/ports/teensy/memzip_files/ @cp -av kmk build/micropython/ports/teensy/memzip_files/
micropython-freeze-kmk-stm32: freeze-stm32-vendor-deps micropython-freeze-kmk-stm32: freeze-stm32-build-deps
@echo "===> Preparing KMK source for bundling into MicroPython" @echo "===> Preparing KMK source for bundling into MicroPython"
@rm -rf vendor/micropython/ports/stm32/freeze/kmk* @rm -rf build/micropython/ports/stm32/freeze/kmk*
@cp -av kmk vendor/micropython/ports/stm32/freeze/ @cp -av kmk build/micropython/ports/stm32/freeze/
circuitpy-build-nrf: circuitpy-build-nrf:
@echo "===> Building CircuitPython" @echo "===> Building CircuitPython"
@make -C vendor/circuitpython/ports/nrf BOARD=feather_nrf52832 SERIAL=${AMPY_PORT} SD=s132 FROZEN_MPY_DIR=freeze clean all @make -C build/circuitpython/ports/nrf BOARD=feather_nrf52832 SERIAL=${AMPY_PORT} SD=s132 FROZEN_MPY_DIR=freeze clean all
circuitpy-flash-nrf: circuitpy-build-nrf circuitpy-flash-nrf: circuitpy-build-nrf
@echo "===> Flashing CircuitPython with KMK and your keymap" @echo "===> Flashing CircuitPython with KMK and your keymap"
@make -C vendor/circuitpython/ports/nrf BOARD=feather_nrf52832 SERIAL=${AMPY_PORT} SD=s132 FROZEN_MPY_DIR=freeze dfu-gen dfu-flash @make -C build/circuitpython/ports/nrf BOARD=feather_nrf52832 SERIAL=${AMPY_PORT} SD=s132 FROZEN_MPY_DIR=freeze dfu-gen dfu-flash
micropython-build-teensy3.1: micropython-build-teensy3.1:
@make -C vendor/micropython/ports/teensy/ BOARD=TEENSY_3.1 all @make -C build/micropython/ports/teensy/ BOARD=TEENSY_3.1 all
micropython-flash-teensy3.1: micropython-build-teensy3.1 micropython-flash-teensy3.1: micropython-build-teensy3.1
@make -C vendor/micropython/ports/teensy/ BOARD=TEENSY_3.1 deploy @make -C build/micropython/ports/teensy/ BOARD=TEENSY_3.1 deploy
micropython-build-pyboard: micropython-build-pyboard:
@make -j4 -C vendor/micropython/ports/stm32/ BOARD=PYBV11 FROZEN_MPY_DIR=freeze all @make -j4 -C build/micropython/ports/stm32/ BOARD=PYBV11 FROZEN_MPY_DIR=freeze all
micropython-flash-pyboard: micropython-build-pyboard micropython-flash-pyboard: micropython-build-pyboard
@make -j4 -C vendor/micropython/ports/stm32/ BOARD=PYBV11 FROZEN_MPY_DIR=freeze deploy @make -j4 -C build/micropython/ports/stm32/ BOARD=PYBV11 FROZEN_MPY_DIR=freeze deploy
circuitpy-flash-nrf-entrypoint: circuitpy-flash-nrf-entrypoint:
@echo "===> Flashing entrypoint if it doesn't already exist" @echo "===> Flashing entrypoint if it doesn't already exist"
@sleep 2 @sleep 2
@-timeout -k 5s 10s pipenv run ampy -p ${AMPY_PORT} -d ${AMPY_DELAY} -b ${AMPY_BAUD} rm main.py 2>/dev/null @-timeout -k 5s 10s $(PIPENV) run ampy -p ${AMPY_PORT} -d ${AMPY_DELAY} -b ${AMPY_BAUD} rm main.py 2>/dev/null
@-timeout -k 5s 10s pipenv run ampy -p ${AMPY_PORT} -d ${AMPY_DELAY} -b ${AMPY_BAUD} put entrypoints/feather_nrf52832.py main.py @-timeout -k 5s 10s $(PIPENV) run ampy -p ${AMPY_PORT} -d ${AMPY_DELAY} -b ${AMPY_BAUD} put entrypoints/feather_nrf52832.py main.py
@echo "===> Flashed keyboard successfully!" @echo "===> Flashed keyboard successfully!"
ifndef USER_KEYMAP ifndef USER_KEYMAP
@ -139,12 +148,12 @@ flash-feather-nrf52832:
else else
build-feather-nrf52832: lint devdeps circuitpy-deps circuitpy-freeze-kmk-nrf build-feather-nrf52832: lint devdeps circuitpy-deps circuitpy-freeze-kmk-nrf
@echo "===> Preparing keyboard script for bundling into CircuitPython" @echo "===> Preparing keyboard script for bundling into CircuitPython"
@cp -av ${USER_KEYMAP} vendor/circuitpython/ports/nrf/freeze/kmk_keyboard_user.py @cp -av ${USER_KEYMAP} build/circuitpython/ports/nrf/freeze/kmk_keyboard_user.py
@$(MAKE) circuitpy-build-nrf @$(MAKE) circuitpy-build-nrf
flash-feather-nrf52832: lint devdeps circuitpy-deps circuitpy-freeze-kmk-nrf flash-feather-nrf52832: lint devdeps circuitpy-deps circuitpy-freeze-kmk-nrf
@echo "===> Preparing keyboard script for bundling into CircuitPython" @echo "===> Preparing keyboard script for bundling into CircuitPython"
@cp -av ${USER_KEYMAP} vendor/circuitpython/ports/nrf/freeze/kmk_keyboard_user.py @cp -av ${USER_KEYMAP} build/circuitpython/ports/nrf/freeze/kmk_keyboard_user.py
@$(MAKE) circuitpy-flash-nrf circuitpy-flash-nrf-entrypoint @$(MAKE) circuitpy-flash-nrf circuitpy-flash-nrf-entrypoint
endif endif
@ -157,12 +166,12 @@ flash-teensy-3.1:
else else
build-teensy-3.1: lint devdeps micropython-deps micropython-freeze-kmk-teensy3.1 build-teensy-3.1: lint devdeps micropython-deps micropython-freeze-kmk-teensy3.1
@echo "===> Preparing keyboard script for bundling into MicroPython" @echo "===> Preparing keyboard script for bundling into MicroPython"
@cp -av ${USER_KEYMAP} vendor/micropython/ports/teensy/freeze/kmk_keyboard_user.py @cp -av ${USER_KEYMAP} build/micropython/ports/teensy/freeze/kmk_keyboard_user.py
@$(MAKE) ARDUINO=${ARDUINO} micropython-build-teensy3.1 @$(MAKE) ARDUINO=${ARDUINO} micropython-build-teensy3.1
flash-teensy-3.1: lint devdeps micropython-deps micropython-freeze-kmk-teensy3.1 flash-teensy-3.1: lint devdeps micropython-deps micropython-freeze-kmk-teensy3.1
@echo "===> Preparing keyboard script for bundling into MicroPython" @echo "===> Preparing keyboard script for bundling into MicroPython"
@cp -av ${USER_KEYMAP} vendor/micropython/ports/teensy/freeze/kmk_keyboard_user.py @cp -av ${USER_KEYMAP} build/micropython/ports/teensy/freeze/kmk_keyboard_user.py
@$(MAKE) ARDUINO=${ARDUINO} micropython-flash-teensy3.1 @$(MAKE) ARDUINO=${ARDUINO} micropython-flash-teensy3.1
endif endif
@ -182,22 +191,22 @@ endif
ifndef SKIP_KEYMAP_VALIDATION ifndef SKIP_KEYMAP_VALIDATION
@MICROPYPATH=./ ./bin/micropython.sh bin/keymap_sanity_check.py ${USER_KEYMAP} @MICROPYPATH=./ ./bin/micropython.sh bin/keymap_sanity_check.py ${USER_KEYMAP}
endif endif
@cp -av ${USER_KEYMAP} vendor/micropython/ports/stm32/freeze/kmk_keyboard_user.py @cp -av ${USER_KEYMAP} build/micropython/ports/stm32/freeze/kmk_keyboard_user.py
@$(MAKE) AMPY_PORT=/dev/ttyACM0 AMPY_BAUD=115200 micropython-build-pyboard @$(MAKE) AMPY_PORT=/dev/ttyACM0 AMPY_BAUD=115200 micropython-build-pyboard
flash-pyboard: lint devdeps micropython-deps micropython-freeze-kmk-stm32 flash-pyboard: lint devdeps micropython-deps micropython-freeze-kmk-stm32
@echo "===> Preparing keyboard script for bundling into MicroPython" @echo "===> Preparing keyboard script for bundling into MicroPython"
@cp -av ${USER_KEYMAP} vendor/micropython/ports/stm32/freeze/kmk_keyboard_user.py @cp -av ${USER_KEYMAP} build/micropython/ports/stm32/freeze/kmk_keyboard_user.py
@cp -av kmk/entrypoints/global.py vendor/micropython/ports/stm32/freeze/_main.py @cp -av kmk/entrypoints/global.py build/micropython/ports/stm32/freeze/_main.py
@cp -av kmk/entrypoints/handwire/pyboard_boot.py vendor/micropython/ports/stm32/freeze/_boot.py @cp -av kmk/entrypoints/handwire/pyboard_boot.py build/micropython/ports/stm32/freeze/_boot.py
@$(MAKE) micropython-flash-pyboard @$(MAKE) micropython-flash-pyboard
endif endif
reset-bootloader: reset-bootloader:
@-timeout -k 5s 10s pipenv run ampy -p /dev/ttyACM0 -d ${AMPY_DELAY} -b ${AMPY_BAUD} run util/bootloader.py @-timeout -k 5s 10s $(PIPENV) run ampy -p /dev/ttyACM0 -d ${AMPY_DELAY} -b ${AMPY_BAUD} run util/bootloader.py
reset-board: reset-board:
@-timeout -k 5s 10s pipenv run ampy -p /dev/ttyACM0 -d ${AMPY_DELAY} -b ${AMPY_BAUD} run util/reset.py @-timeout -k 5s 10s $(PIPENV) run ampy -p /dev/ttyACM0 -d ${AMPY_DELAY} -b ${AMPY_BAUD} run util/reset.py
# Fully wipe the board with only stock CircuitPython # Fully wipe the board with only stock CircuitPython
burn-it-all-with-fire: lint devdeps burn-it-all-with-fire: lint devdeps
@ -207,14 +216,14 @@ burn-it-all-with-fire: lint devdeps
@echo "===> Pulling dependencies, this may take several minutes" @echo "===> Pulling dependencies, this may take several minutes"
@git submodule update --init --recursive @git submodule update --init --recursive
@echo "===> Building circuitpython/mpy-cross" @echo "===> Building circuitpython/mpy-cross"
@make -C vendor/circuitpython/mpy-cross @make -C build/circuitpython/mpy-cross
@echo "===> Pulling Nordic BLE stack" @echo "===> Pulling Nordic BLE stack"
@cd vendor/circuitpython/ports/nrf && ./drivers/bluetooth/download_ble_stack.sh 2>/dev/null >/dev/null @cd build/circuitpython/ports/nrf && ./drivers/bluetooth/download_ble_stack.sh 2>/dev/null >/dev/null
@echo "===> Preparing KMK source for bundling into CircuitPython" @echo "===> Preparing KMK source for bundling into CircuitPython"
@rm -rf vendor/circuitpython/ports/nrf/* @rm -rf build/circuitpython/ports/nrf/*
@echo "===> Building CircuitPython WITHOUT KMK or user keyboard script to induce ImportError" @echo "===> Building CircuitPython WITHOUT KMK or user keyboard script to induce ImportError"
@$(MAKE) circuitpy-flash-nrf @$(MAKE) circuitpy-flash-nrf
@echo "===> Wiping keyboard config" @echo "===> Wiping keyboard config"
@sleep 2 @sleep 2
@-timeout -k 5s 10s pipenv run ampy -p ${AMPY_PORT} -d ${AMPY_DELAY} -b ${AMPY_BAUD} rm main.py 2>/dev/null @-timeout -k 5s 10s $(PIPENV) run ampy -p ${AMPY_PORT} -d ${AMPY_DELAY} -b ${AMPY_BAUD} rm main.py 2>/dev/null
@echo "===> Wiped! Probably safe to flash keyboard, try Python serial REPL to verify?" @echo "===> Wiped! Probably safe to flash keyboard, try Python serial REPL to verify?"

4
bin/micropython.sh
View File

@ -1,6 +1,6 @@
if [ ! -f vendor/micropython/ports/unix/micropython ]; then if [ ! -f build/micropython/ports/unix/micropython ]; then
echo "Run make micropython-build-unix" echo "Run make micropython-build-unix"
exit 1 exit 1
fi fi
vendor/micropython/ports/unix/micropython $@ build/micropython/ports/unix/micropython $@

2
setup.cfg
View File

@ -1,5 +1,5 @@
[flake8] [flake8]
exclude = .git,__pycache__,vendor,.venv exclude = .git,__pycache__,vendor,.venv,build
max_line_length = 99 max_line_length = 99
ignore = X100, E262 ignore = X100, E262
per-file-ignores = per-file-ignores =

4
submodules.toml Normal file
View File

@ -0,0 +1,4 @@
[submodules]
"vendor/circuitpython" = "d751740"
"vendor/micropython" = "65a49fa"
"vendor/upy-lib" = "f20d89c"