# OpenPuck developer convenience targets. # Pin to clang-format 18 to match CI; output differs between versions, so a # mismatch would make CI reject locally-formatted code. Resolve the binary in # order of preference: the apt-style versioned name (CI / Linux), the Homebrew # llvm@18 keg (macOS), then a bare clang-format as a last resort. Override with # `make format CLANG_FORMAT=/path/to/clang-format` if yours lives elsewhere. CLANG_FORMAT ?= $(shell command -v clang-format-18 \ || ([ -x /opt/homebrew/opt/llvm@18/bin/clang-format ] && echo /opt/homebrew/opt/llvm@18/bin/clang-format) \ || ([ -x /usr/local/opt/llvm@18/bin/clang-format ] && echo /usr/local/opt/llvm@18/bin/clang-format) \ || command -v clang-format) # All hand-written C/C++ sources. Generated headers (git_version.h) are # gitignored and excluded here so formatting never touches them. FORMAT_FILES := $(shell find OpenPuck ReversePuckFirmware puck_sniffer pairtui \ \( -name '*.c' -o -name '*.cpp' -o -name '*.h' -o -name '*.hpp' -o -name '*.ino' \) \ -not -name 'git_version.h') # --- firmware build --------------------------------------------------------- # The OpenPuck firmware needs two TinyUSB config values that differ from the Adafruit nRF52 core defaults: # CFG_TUD_HID=4 -- four HID interfaces (Steam mode exposes four puck slots); core default is 2. # CFG_TUD_TASK_QUEUE_SZ=64 -- deeper usbd event queue; the default 16 deadlocks the loop task under comms # load -> watchdog reset (see OpenPuck.ino + docs/BUILD_AND_DEPLOY.md). # They're baked in here so a normal build is just `make build` -- no need to remember the flags. Override any # on the command line, e.g. make build CFG_TUD_HID=6 CFG_TUD_TASK_QUEUE_SZ=128 # or add your own defines: make build EXTRA_FLAGS="-DOPK_LOG=1" FQBN ?= adafruit:nrf52:feather52840 CFG_TUD_HID ?= 4 CFG_TUD_TASK_QUEUE_SZ ?= 64 EXTRA_FLAGS ?= # {build.flags.usb} is expanded by arduino-cli (VID/PID/strings); pass it through verbatim. USB_EXTRA_FLAGS = -DNRF52840_XXAA {build.flags.usb} -DCFG_TUD_HID=$(CFG_TUD_HID) -DCFG_TUD_TASK_QUEUE_SZ=$(CFG_TUD_TASK_QUEUE_SZ) $(EXTRA_FLAGS) .PHONY: format format-check check build build-recovery ## Compile the firmware with the required USB flags baked in. Override CFG_TUD_HID / CFG_TUD_TASK_QUEUE_SZ / ## EXTRA_FLAGS / FQBN as make variables if needed. build: arduino-cli compile -b $(FQBN) --build-property "build.extra_flags=$(USB_EXTRA_FLAGS)" OpenPuck ## One-time factory-reset recovery image (wipes persistent storage once on first boot). See ยง6 of the build doc. build-recovery: $(MAKE) build EXTRA_FLAGS="$(EXTRA_FLAGS) -DOPK_FACTORY_RESET=1" ## Reformat all C/C++ sources in place using the Linux kernel style. format: $(CLANG_FORMAT) -i $(FORMAT_FILES) ## Verify all C/C++ sources are formatted; exit non-zero if any differ. ## Used by CI to reject unformatted code. format-check: $(CLANG_FORMAT) --dry-run --Werror $(FORMAT_FILES) ## Everything CI gates on. check: format-check