Fix comment typo
[betaflight.git] / Makefile
blob62dd6df623220360e1bb53e6298b8c846ff39574
1 ###############################################################################
2 # "THE BEER-WARE LICENSE" (Revision 42):
3 # <msmith@FreeBSD.ORG> wrote this file. As long as you retain this notice you
4 # can do whatever you want with this stuff. If we meet some day, and you think
5 # this stuff is worth it, you can buy me a beer in return
6 ###############################################################################
8 # Makefile for building the betaflight firmware.
10 # Invoke this with 'make help' to see the list of supported targets.
12 ###############################################################################
15 # Things that the user might override on the commandline
18 # The target to build, see VALID_TARGETS below
19 TARGET ?= STM32F405
21 # Compile-time options
22 OPTIONS ?=
24 # compile for OpenPilot BootLoader support
25 OPBL ?= no
27 # compile for External Storage Bootloader support
28 EXST ?= no
30 # compile for target loaded into RAM
31 RAM_BASED ?= no
33 # reserve space for custom defaults
34 CUSTOM_DEFAULTS_EXTENDED ?= no
36 # Debugger optons:
37 # empty - ordinary build with all optimizations enabled
38 # INFO - ordinary build with debug symbols and all optimizations enabled
39 # GDB - debug build with minimum number of optimizations
40 DEBUG ?=
42 # Insert the debugging hardfault debugger
43 # releases should not be built with this flag as it does not disable pwm output
44 DEBUG_HARDFAULTS ?=
46 # Serial port/Device for flashing
47 SERIAL_DEVICE ?= $(firstword $(wildcard /dev/ttyACM*) $(firstword $(wildcard /dev/ttyUSB*) no-port-found))
49 # Flash size (KB). Some low-end chips actually have more flash than advertised, use this to override.
50 FLASH_SIZE ?=
52 # Release file naming (no revision to be present if this is 'yes')
53 RELEASE ?= no
55 ###############################################################################
56 # Things that need to be maintained as the source changes
59 FORKNAME = betaflight
61 # Working directories
62 ROOT := $(patsubst %/,%,$(dir $(lastword $(MAKEFILE_LIST))))
63 SRC_DIR := $(ROOT)/src/main
64 OBJECT_DIR := $(ROOT)/obj/main
65 BIN_DIR := $(ROOT)/obj
66 CMSIS_DIR := $(ROOT)/lib/main/CMSIS
67 INCLUDE_DIRS := $(SRC_DIR) \
68 $(ROOT)/src/main/target \
69 $(ROOT)/src/main/startup
70 LINKER_DIR := $(ROOT)/src/link
72 ## V : Set verbosity level based on the V= parameter
73 ## V=0 Low
74 ## V=1 High
75 include $(ROOT)/make/build_verbosity.mk
77 # Build tools, so we all share the same versions
78 # import macros common to all supported build systems
79 include $(ROOT)/make/system-id.mk
81 # developer preferences, edit these at will, they'll be gitignored
82 -include $(ROOT)/make/local.mk
84 # pre-build sanity checks
85 include $(ROOT)/make/checks.mk
87 # configure some directories that are relative to wherever ROOT_DIR is located
88 TOOLS_DIR ?= $(ROOT)/tools
89 DL_DIR := $(ROOT)/downloads
91 export RM := rm
93 # import macros that are OS specific
94 include $(ROOT)/make/$(OSFAMILY).mk
96 # include the tools makefile
97 include $(ROOT)/make/tools.mk
99 # default xtal value for F4 targets
100 HSE_VALUE ?= 8000000
102 # used for turning on features like VCP and SDCARD
103 FEATURES =
105 # used to disable features based on flash space shortage (larger number => more features disabled)
106 FEATURE_CUT_LEVEL_SUPPLIED := $(FEATURE_CUT_LEVEL)
107 FEATURE_CUT_LEVEL =
109 # The list of targets to build for 'pre-push'
110 ifeq ($(OSFAMILY), macosx)
111 # SITL is not buildable on MacOS
112 PRE_PUSH_TARGET_LIST ?= $(UNIFIED_TARGETS) STM32F4DISCOVERY_DEBUG test-representative
113 else
114 PRE_PUSH_TARGET_LIST ?= $(UNIFIED_TARGETS) SITL STM32F4DISCOVERY_DEBUG test-representative
115 endif
117 include $(ROOT)/make/targets.mk
119 REVISION := norevision
120 ifeq ($(shell git diff --shortstat),)
121 REVISION := $(shell git log -1 --format="%h")
122 endif
124 FC_VER_MAJOR := $(shell grep " FC_VERSION_MAJOR" src/main/build/version.h | awk '{print $$3}' )
125 FC_VER_MINOR := $(shell grep " FC_VERSION_MINOR" src/main/build/version.h | awk '{print $$3}' )
126 FC_VER_PATCH := $(shell grep " FC_VERSION_PATCH" src/main/build/version.h | awk '{print $$3}' )
128 FC_VER := $(FC_VER_MAJOR).$(FC_VER_MINOR).$(FC_VER_PATCH)
130 # Search path for sources
131 VPATH := $(SRC_DIR):$(SRC_DIR)/startup
132 USBFS_DIR = $(ROOT)/lib/main/STM32_USB-FS-Device_Driver
133 USBPERIPH_SRC = $(notdir $(wildcard $(USBFS_DIR)/src/*.c))
134 FATFS_DIR = $(ROOT)/lib/main/FatFS
135 FATFS_SRC = $(notdir $(wildcard $(FATFS_DIR)/*.c))
137 CSOURCES := $(shell find $(SRC_DIR) -name '*.c')
139 LD_FLAGS :=
140 EXTRA_LD_FLAGS :=
143 # Default Tool options - can be overridden in {mcu}.mk files.
145 ifeq ($(DEBUG),GDB)
146 OPTIMISE_DEFAULT := -Og
148 LTO_FLAGS := $(OPTIMISE_DEFAULT)
149 DEBUG_FLAGS = -ggdb3 -DDEBUG
150 else
151 ifeq ($(DEBUG),INFO)
152 DEBUG_FLAGS = -ggdb3
153 endif
154 OPTIMISATION_BASE := -flto -fuse-linker-plugin -ffast-math -fmerge-all-constants
155 OPTIMISE_DEFAULT := -O2
156 OPTIMISE_SPEED := -Ofast
157 OPTIMISE_SIZE := -Os
159 LTO_FLAGS := $(OPTIMISATION_BASE) $(OPTIMISE_SPEED)
160 endif
162 VPATH := $(VPATH):$(ROOT)/make/mcu
163 VPATH := $(VPATH):$(ROOT)/make
165 # start specific includes
166 include $(ROOT)/make/mcu/$(TARGET_MCU).mk
168 # openocd specific includes
169 include $(ROOT)/make/openocd.mk
171 # Configure default flash sizes for the targets (largest size specified gets hit first) if flash not specified already.
172 ifeq ($(TARGET_FLASH_SIZE),)
173 ifneq ($(MCU_FLASH_SIZE),)
174 TARGET_FLASH_SIZE := $(MCU_FLASH_SIZE)
175 else
176 $(error MCU_FLASH_SIZE not configured for target $(TARGET))
177 endif
178 endif
180 DEVICE_FLAGS := $(DEVICE_FLAGS) -DTARGET_FLASH_SIZE=$(TARGET_FLASH_SIZE)
182 ifneq ($(HSE_VALUE),)
183 DEVICE_FLAGS := $(DEVICE_FLAGS) -DHSE_VALUE=$(HSE_VALUE)
184 endif
186 ifneq ($(FEATURE_CUT_LEVEL_SUPPLIED),)
187 DEVICE_FLAGS := $(DEVICE_FLAGS) -DFEATURE_CUT_LEVEL=$(FEATURE_CUT_LEVEL_SUPPLIED)
188 else ifneq ($(FEATURE_CUT_LEVEL),)
189 DEVICE_FLAGS := $(DEVICE_FLAGS) -DFEATURE_CUT_LEVEL=$(FEATURE_CUT_LEVEL)
190 endif
192 TARGET_DIR = $(ROOT)/src/main/target/$(BASE_TARGET)
193 TARGET_DIR_SRC = $(notdir $(wildcard $(TARGET_DIR)/*.c))
195 ifeq ($(OPBL),yes)
196 TARGET_FLAGS := -DOPBL $(TARGET_FLAGS)
197 .DEFAULT_GOAL := binary
198 else
199 .DEFAULT_GOAL := hex
200 endif
202 ifeq ($(CUSTOM_DEFAULTS_EXTENDED),yes)
203 TARGET_FLAGS += -DUSE_CUSTOM_DEFAULTS=
204 EXTRA_LD_FLAGS += -Wl,--defsym=USE_CUSTOM_DEFAULTS_EXTENDED=1
205 endif
207 INCLUDE_DIRS := $(INCLUDE_DIRS) \
208 $(ROOT)/lib/main/MAVLink
210 INCLUDE_DIRS := $(INCLUDE_DIRS) \
211 $(TARGET_DIR)
213 VPATH := $(VPATH):$(TARGET_DIR)
215 include $(ROOT)/make/source.mk
217 ###############################################################################
218 # Things that might need changing to use different tools
221 # Find out if ccache is installed on the system
222 CCACHE := ccache
223 RESULT = $(shell (which $(CCACHE) > /dev/null 2>&1; echo $$?) )
224 ifneq ($(RESULT),0)
225 CCACHE :=
226 endif
228 # Tool names
229 CROSS_CC := $(CCACHE) $(ARM_SDK_PREFIX)gcc
230 CROSS_CXX := $(CCACHE) $(ARM_SDK_PREFIX)g++
231 CROSS_GDB := $(ARM_SDK_PREFIX)gdb
232 OBJCOPY := $(ARM_SDK_PREFIX)objcopy
233 OBJDUMP := $(ARM_SDK_PREFIX)objdump
234 READELF := $(ARM_SDK_PREFIX)readelf
235 SIZE := $(ARM_SDK_PREFIX)size
236 DFUSE-PACK := src/utils/dfuse-pack.py
239 # Tool options.
241 CC_DEBUG_OPTIMISATION := $(OPTIMISE_DEFAULT)
242 CC_DEFAULT_OPTIMISATION := $(OPTIMISATION_BASE) $(OPTIMISE_DEFAULT)
243 CC_SPEED_OPTIMISATION := $(OPTIMISATION_BASE) $(OPTIMISE_SPEED)
244 CC_SIZE_OPTIMISATION := $(OPTIMISATION_BASE) $(OPTIMISE_SIZE)
245 CC_NO_OPTIMISATION :=
248 # Added after GCC version update, remove once the warnings have been fixed
250 TEMPORARY_FLAGS :=
252 CFLAGS += $(ARCH_FLAGS) \
253 $(addprefix -D,$(OPTIONS)) \
254 $(addprefix -I,$(INCLUDE_DIRS)) \
255 $(DEBUG_FLAGS) \
256 -std=gnu11 \
257 -Wall -Wextra -Wunsafe-loop-optimizations -Wdouble-promotion \
258 -ffunction-sections \
259 -fdata-sections \
260 -fno-common \
261 -pedantic \
262 $(TEMPORARY_FLAGS) \
263 $(DEVICE_FLAGS) \
264 -D_GNU_SOURCE \
265 -DUSE_STDPERIPH_DRIVER \
266 -D$(TARGET) \
267 $(TARGET_FLAGS) \
268 -D'__FORKNAME__="$(FORKNAME)"' \
269 -D'__TARGET__="$(TARGET)"' \
270 -D'__REVISION__="$(REVISION)"' \
271 -save-temps=obj \
272 -MMD -MP \
273 $(EXTRA_FLAGS)
275 ASFLAGS = $(ARCH_FLAGS) \
276 $(DEBUG_FLAGS) \
277 -x assembler-with-cpp \
278 $(addprefix -I,$(INCLUDE_DIRS)) \
279 -MMD -MP
281 ifeq ($(LD_FLAGS),)
282 LD_FLAGS = -lm \
283 -nostartfiles \
284 --specs=nano.specs \
285 -lc \
286 -lnosys \
287 $(ARCH_FLAGS) \
288 $(LTO_FLAGS) \
289 $(DEBUG_FLAGS) \
290 -static \
291 -Wl,-gc-sections,-Map,$(TARGET_MAP) \
292 -Wl,-L$(LINKER_DIR) \
293 -Wl,--cref \
294 -Wl,--no-wchar-size-warning \
295 -Wl,--print-memory-usage \
296 -T$(LD_SCRIPT) \
297 $(EXTRA_LD_FLAGS)
298 endif
300 ###############################################################################
301 # No user-serviceable parts below
302 ###############################################################################
304 CPPCHECK = cppcheck $(CSOURCES) --enable=all --platform=unix64 \
305 --std=c99 --inline-suppr --quiet --force \
306 $(addprefix -I,$(INCLUDE_DIRS)) \
307 -I/usr/include -I/usr/include/linux
309 ifeq ($(RELEASE),yes)
310 TARGET_BASENAME = $(BIN_DIR)/$(FORKNAME)_$(FC_VER)_$(TARGET)
311 else
312 TARGET_BASENAME = $(BIN_DIR)/$(FORKNAME)_$(FC_VER)_$(TARGET)_$(REVISION)
313 endif
316 # Things we will build
318 TARGET_BIN = $(TARGET_BASENAME).bin
319 TARGET_HEX = $(TARGET_BASENAME).hex
320 TARGET_DFU = $(TARGET_BASENAME).dfu
321 TARGET_ZIP = $(TARGET_BASENAME).zip
322 TARGET_ELF = $(OBJECT_DIR)/$(FORKNAME)_$(TARGET).elf
323 TARGET_EXST_ELF = $(OBJECT_DIR)/$(FORKNAME)_$(TARGET)_EXST.elf
324 TARGET_UNPATCHED_BIN = $(OBJECT_DIR)/$(FORKNAME)_$(TARGET)_UNPATCHED.bin
325 TARGET_LST = $(OBJECT_DIR)/$(FORKNAME)_$(TARGET).lst
326 TARGET_OBJS = $(addsuffix .o,$(addprefix $(OBJECT_DIR)/$(TARGET)/,$(basename $(SRC))))
327 TARGET_DEPS = $(addsuffix .d,$(addprefix $(OBJECT_DIR)/$(TARGET)/,$(basename $(SRC))))
328 TARGET_MAP = $(OBJECT_DIR)/$(FORKNAME)_$(TARGET).map
330 TARGET_EXST_HASH_SECTION_FILE = $(OBJECT_DIR)/$(TARGET)/exst_hash_section.bin
332 CLEAN_ARTIFACTS := $(TARGET_BIN)
333 CLEAN_ARTIFACTS += $(TARGET_HEX)
334 CLEAN_ARTIFACTS += $(TARGET_ELF) $(TARGET_OBJS) $(TARGET_MAP)
335 CLEAN_ARTIFACTS += $(TARGET_LST)
336 CLEAN_ARTIFACTS += $(TARGET_DFU)
338 # Make sure build date and revision is updated on every incremental build
339 $(OBJECT_DIR)/$(TARGET)/build/version.o : $(SRC)
341 # List of buildable ELF files and their object dependencies.
342 # It would be nice to compute these lists, but that seems to be just beyond make.
344 $(TARGET_LST): $(TARGET_ELF)
345 $(V0) $(OBJDUMP) -S --disassemble $< > $@
347 ifeq ($(EXST),no)
348 $(TARGET_BIN): $(TARGET_ELF)
349 @echo "Creating BIN $(TARGET_BIN)" "$(STDOUT)"
350 $(V1) $(OBJCOPY) -O binary $< $@
352 $(TARGET_HEX): $(TARGET_ELF)
353 @echo "Creating HEX $(TARGET_HEX)" "$(STDOUT)"
354 $(V1) $(OBJCOPY) -O ihex --set-start 0x8000000 $< $@
356 $(TARGET_DFU): $(TARGET_HEX)
357 @echo "Creating DFU $(TARGET_DFU)" "$(STDOUT)"
358 $(V1) $(PYTHON) $(DFUSE-PACK) -i $< $@
360 else
361 CLEAN_ARTIFACTS += $(TARGET_UNPATCHED_BIN) $(TARGET_EXST_HASH_SECTION_FILE) $(TARGET_EXST_ELF)
363 $(TARGET_UNPATCHED_BIN): $(TARGET_ELF)
364 @echo "Creating BIN (without checksum) $(TARGET_UNPATCHED_BIN)" "$(STDOUT)"
365 $(V1) $(OBJCOPY) -O binary $< $@
367 $(TARGET_BIN): $(TARGET_UNPATCHED_BIN)
368 @echo "Creating EXST $(TARGET_BIN)" "$(STDOUT)"
369 # Linker script should allow .bin generation from a .elf which results in a file that is the same length as the FIRMWARE_SIZE.
370 # These 'dd' commands will pad a short binary to length FIRMWARE_SIZE.
371 $(V1) dd if=/dev/zero ibs=1k count=$(FIRMWARE_SIZE) of=$(TARGET_BIN)
372 $(V1) dd if=$(TARGET_UNPATCHED_BIN) of=$(TARGET_BIN) conv=notrunc
374 @echo "Generating MD5 hash of binary" "$(STDOUT)"
375 $(V1) openssl dgst -md5 $(TARGET_BIN) > $(TARGET_UNPATCHED_BIN).md5
377 @echo "Patching MD5 hash into binary" "$(STDOUT)"
378 $(V1) cat $(TARGET_UNPATCHED_BIN).md5 | awk '{printf("%08x: %s",(1024*$(FIRMWARE_SIZE))-16,$$2);}' | xxd -r - $(TARGET_BIN)
379 $(V1) echo $(FIRMWARE_SIZE) | awk '{printf("-s 0x%08x -l 16 -c 16 %s",(1024*$$1)-16,"$(TARGET_BIN)");}' | xargs xxd
381 # Note: From the objcopy manual "If you do not specify outfile, objcopy creates a temporary file and destructively renames the result with the name of infile"
382 # Due to this a temporary file must be created and removed, even though we're only extracting data from the input file.
383 # If this temporary file is NOT used the $(TARGET_ELF) is modified, and running make a second time will result in
384 # a) regeneration of $(TARGET_BIN), and
385 # b) the results of $(TARGET_BIN) will not be as expected.
386 @echo "Extracting HASH section from unpatched EXST elf $(TARGET_ELF)" "$(STDOUT)"
387 $(OBJCOPY) $(TARGET_ELF) $(TARGET_EXST_ELF).tmp --dump-section .exst_hash=$(TARGET_EXST_HASH_SECTION_FILE) -j .exst_hash
388 rm $(TARGET_EXST_ELF).tmp
390 @echo "Patching MD5 hash into HASH section" "$(STDOUT)"
391 $(V1) cat $(TARGET_UNPATCHED_BIN).md5 | awk '{printf("%08x: %s",64-16,$$2);}' | xxd -r - $(TARGET_EXST_HASH_SECTION_FILE)
393 # For some currently unknown reason, OBJCOPY, with only input/output files, will generate a file around 2GB for the H730 unless we remove an unused-section
394 # As a workaround drop the ._user_heap_stack section, which is only used during build to show errors if there's not enough space for the heap/stack.
395 # The issue can be seen with `readelf -S $(TARGET_EXST_ELF)' vs `readelf -S $(TARGET_ELF)`
396 $(V1) @echo "Patching updated HASH section into $(TARGET_EXST_ELF)" "$(STDOUT)"
397 $(OBJCOPY) $(TARGET_ELF) $(TARGET_EXST_ELF) --remove-section ._user_heap_stack --update-section .exst_hash=$(TARGET_EXST_HASH_SECTION_FILE)
399 $(V1) $(READELF) -S $(TARGET_EXST_ELF)
400 $(V1) $(READELF) -l $(TARGET_EXST_ELF)
402 $(TARGET_HEX): $(TARGET_BIN)
403 $(if $(EXST_ADJUST_VMA),,$(error "EXST_ADJUST_VMA not specified"))
405 @echo "Creating EXST HEX from patched EXST BIN $(TARGET_BIN), VMA Adjust $(EXST_ADJUST_VMA)" "$(STDOUT)"
406 $(V1) $(OBJCOPY) -I binary -O ihex --adjust-vma=$(EXST_ADJUST_VMA) $(TARGET_BIN) $@
408 endif
410 $(TARGET_ELF): $(TARGET_OBJS) $(LD_SCRIPT) $(LD_SCRIPTS)
411 @echo "Linking $(TARGET)" "$(STDOUT)"
412 $(V1) $(CROSS_CC) -o $@ $(filter-out %.ld,$^) $(LD_FLAGS)
413 $(V1) $(SIZE) $(TARGET_ELF)
415 # Compile
417 ## compile_file takes two arguments: (1) optimisation description string and (2) optimisation compiler flag
418 define compile_file
419 echo "%% ($(1)) $<" "$(STDOUT)" && \
420 $(CROSS_CC) -c -o $@ $(CFLAGS) $(2) $<
421 endef
423 ifeq ($(DEBUG),GDB)
424 $(OBJECT_DIR)/$(TARGET)/%.o: %.c
425 $(V1) mkdir -p $(dir $@)
426 $(V1) $(if $(findstring $<,$(NOT_OPTIMISED_SRC)), \
427 $(call compile_file,not optimised, $(CC_NO_OPTIMISATION)) \
429 $(call compile_file,debug,$(CC_DEBUG_OPTIMISATION)) \
431 else
432 $(OBJECT_DIR)/$(TARGET)/%.o: %.c
433 $(V1) mkdir -p $(dir $@)
434 $(V1) $(if $(findstring $<,$(NOT_OPTIMISED_SRC)), \
435 $(call compile_file,not optimised,$(CC_NO_OPTIMISATION)) \
437 $(if $(findstring $(subst ./src/main/,,$<),$(SPEED_OPTIMISED_SRC)), \
438 $(call compile_file,speed optimised,$(CC_SPEED_OPTIMISATION)) \
440 $(if $(findstring $(subst ./src/main/,,$<),$(SIZE_OPTIMISED_SRC)), \
441 $(call compile_file,size optimised,$(CC_SIZE_OPTIMISATION)) \
443 $(call compile_file,optimised,$(CC_DEFAULT_OPTIMISATION)) \
447 endif
449 # Assemble
450 $(OBJECT_DIR)/$(TARGET)/%.o: %.s
451 $(V1) mkdir -p $(dir $@)
452 @echo "%% $(notdir $<)" "$(STDOUT)"
453 $(V1) $(CROSS_CC) -c -o $@ $(ASFLAGS) $<
455 $(OBJECT_DIR)/$(TARGET)/%.o: %.S
456 $(V1) mkdir -p $(dir $@)
457 @echo "%% $(notdir $<)" "$(STDOUT)"
458 $(V1) $(CROSS_CC) -c -o $@ $(ASFLAGS) $<
461 ## all : Build all currently built targets
462 all: $(CI_TARGETS)
464 ## all_all : Build all targets (including legacy / unsupported)
465 all_all: $(VALID_TARGETS)
467 ## unified : build all Unified Targets
468 unified: $(UNIFIED_TARGETS)
470 ## unified_zip : build all Unified Targets as zip files (for posting on GitHub)
471 unified_zip: $(addsuffix _clean,$(UNIFIED_TARGETS)) $(addsuffix _zip,$(UNIFIED_TARGETS))
473 ## legacy : Build legacy targets
474 legacy: $(LEGACY_TARGETS)
476 ## unsupported : Build unsupported targets
477 unsupported: $(UNSUPPORTED_TARGETS)
479 ## pre-push : The minimum verification that should be run before pushing, to check if CI has a chance of succeeding
480 pre-push:
481 $(MAKE) $(addsuffix _clean,$(PRE_PUSH_TARGET_LIST)) $(PRE_PUSH_TARGET_LIST) EXTRA_FLAGS=-Werror
483 ## targets-group-1 : build some targets
484 targets-group-1: $(GROUP_1_TARGETS)
486 ## targets-group-2 : build some targets
487 targets-group-2: $(GROUP_2_TARGETS)
489 ## targets-group-rest: build the rest of the targets (not listed in the other groups)
490 targets-group-rest: $(GROUP_OTHER_TARGETS)
492 $(VALID_TARGETS):
493 $(V0) @echo "Building $@" && \
494 $(MAKE) hex TARGET=$@ && \
495 echo "Building $@ succeeded."
497 $(NOBUILD_TARGETS):
498 $(MAKE) TARGET=$@
500 TARGETS_CLEAN = $(addsuffix _clean,$(VALID_TARGETS))
502 ## clean : clean up temporary / machine-generated files
503 clean:
504 @echo "Cleaning $(TARGET)"
505 $(V0) rm -f $(CLEAN_ARTIFACTS)
506 $(V0) rm -rf $(OBJECT_DIR)/$(TARGET)
507 @echo "Cleaning $(TARGET) succeeded."
509 ## test_clean : clean up temporary / machine-generated files (tests)
510 test-%_clean:
511 $(MAKE) test_clean
513 test_clean:
514 $(V0) cd src/test && $(MAKE) clean || true
516 ## <TARGET>_clean : clean up one specific target (alias for above)
517 $(TARGETS_CLEAN):
518 $(V0) $(MAKE) -j TARGET=$(subst _clean,,$@) clean
520 ## clean_all : clean all valid targets
521 clean_all: $(TARGETS_CLEAN) test_clean
523 TARGETS_FLASH = $(addsuffix _flash,$(VALID_TARGETS))
525 ## <TARGET>_flash : build and flash a target
526 $(TARGETS_FLASH):
527 $(V0) $(MAKE) hex TARGET=$(subst _flash,,$@)
528 ifneq (,$(findstring /dev/ttyUSB,$(SERIAL_DEVICE)))
529 $(V0) $(MAKE) tty_flash TARGET=$(subst _flash,,$@)
530 else
531 $(V0) $(MAKE) dfu_flash TARGET=$(subst _flash,,$@)
532 endif
534 ## tty_flash : flash firmware (.hex) onto flight controller via a serial port
535 tty_flash:
536 $(V0) stty -F $(SERIAL_DEVICE) raw speed 115200 -crtscts cs8 -parenb -cstopb -ixon
537 $(V0) echo -n 'R' > $(SERIAL_DEVICE)
538 $(V0) stm32flash -w $(TARGET_HEX) -v -g 0x0 -b 115200 $(SERIAL_DEVICE)
540 ## dfu_flash : flash firmware (.bin) onto flight controller via a DFU mode
541 dfu_flash:
542 ifneq (no-port-found,$(SERIAL_DEVICE))
543 # potentially this is because the MCU already is in DFU mode, try anyway
544 $(V0) echo -n 'R' > $(SERIAL_DEVICE)
545 $(V0) sleep 1
546 endif
547 $(V0) $(MAKE) $(TARGET_DFU)
548 $(V0) dfu-util -a 0 -D $(TARGET_DFU) -s :leave
550 st-flash_$(TARGET): $(TARGET_BIN)
551 $(V0) st-flash --reset write $< 0x08000000
553 ## st-flash : flash firmware (.bin) onto flight controller
554 st-flash: st-flash_$(TARGET)
556 ifneq ($(OPENOCD_COMMAND),)
557 openocd-gdb: $(TARGET_ELF)
558 $(V0) $(OPENOCD_COMMAND) & $(CROSS_GDB) $(TARGET_ELF) -ex "target remote localhost:3333" -ex "load"
559 endif
561 TARGETS_ZIP = $(addsuffix _zip,$(VALID_TARGETS))
563 ## <TARGET>_zip : build target and zip it (useful for posting to GitHub)
564 $(TARGETS_ZIP):
565 $(V0) $(MAKE) hex TARGET=$(subst _zip,,$@)
566 $(V0) $(MAKE) zip TARGET=$(subst _zip,,$@)
568 zip:
569 $(V0) zip $(TARGET_ZIP) $(TARGET_HEX)
571 binary:
572 $(V0) $(MAKE) -j $(TARGET_BIN)
574 hex:
575 $(V0) $(MAKE) -j $(TARGET_HEX)
577 unbrick_$(TARGET): $(TARGET_HEX)
578 $(V0) stty -F $(SERIAL_DEVICE) raw speed 115200 -crtscts cs8 -parenb -cstopb -ixon
579 $(V0) stm32flash -w $(TARGET_HEX) -v -g 0x0 -b 115200 $(SERIAL_DEVICE)
581 ## unbrick : unbrick flight controller
582 unbrick: unbrick_$(TARGET)
584 ## cppcheck : run static analysis on C source code
585 cppcheck: $(CSOURCES)
586 $(V0) $(CPPCHECK)
588 cppcheck-result.xml: $(CSOURCES)
589 $(V0) $(CPPCHECK) --xml-version=2 2> cppcheck-result.xml
591 # mkdirs
592 $(DL_DIR):
593 mkdir -p $@
595 $(TOOLS_DIR):
596 mkdir -p $@
598 ## version : print firmware version
599 version:
600 @echo $(FC_VER)
602 ## help : print this help message and exit
603 help: Makefile make/tools.mk
604 @echo ""
605 @echo "Makefile for the $(FORKNAME) firmware"
606 @echo ""
607 @echo "Usage:"
608 @echo " make [V=<verbosity>] [TARGET=<target>] [OPTIONS=\"<options>\"]"
609 @echo "Or:"
610 @echo " make <target> [V=<verbosity>] [OPTIONS=\"<options>\"]"
611 @echo ""
612 @echo "Valid TARGET values are: $(VALID_TARGETS)"
613 @echo ""
614 @sed -n 's/^## //p' $?
616 ## targets : print a list of all valid target platforms (for consumption by scripts)
617 targets:
618 @echo "Valid targets: $(VALID_TARGETS)"
619 @echo "Built targets: $(CI_TARGETS)"
620 @echo "Unified targets: $(UNIFIED_TARGETS)"
621 @echo "Legacy targets: $(LEGACY_TARGETS)"
622 @echo "Unsupported targets: $(UNSUPPORTED_TARGETS)"
623 @echo "Default target: $(TARGET)"
624 @echo "targets-group-1: $(GROUP_1_TARGETS)"
625 @echo "targets-group-2: $(GROUP_2_TARGETS)"
626 @echo "targets-group-rest: $(GROUP_OTHER_TARGETS)"
628 @echo "targets-group-1: $(words $(GROUP_1_TARGETS)) targets"
629 @echo "targets-group-2: $(words $(GROUP_2_TARGETS)) targets"
630 @echo "targets-group-rest: $(words $(GROUP_OTHER_TARGETS)) targets"
631 @echo "total in all groups $(words $(CI_TARGETS)) targets"
633 ## target-mcu : print the MCU type of the target
634 target-mcu:
635 @echo $(TARGET_MCU)
637 ## targets-by-mcu : make all targets that have a MCU_TYPE mcu
638 targets-by-mcu:
639 $(V1) for target in $${TARGETS}; do \
640 TARGET_MCU_TYPE=$$($(MAKE) -s TARGET=$${target} target-mcu); \
641 if [ "$${TARGET_MCU_TYPE}" = "$${MCU_TYPE}" ]; then \
642 if [ "$${DO_BUILD}" = 1 ]; then \
643 echo "Building target $${target}..."; \
644 $(MAKE) TARGET=$${target}; \
645 if [ $$? -ne 0 ]; then \
646 echo "Building target $${target} failed, aborting."; \
647 exit 1; \
648 fi; \
649 else \
650 echo -n "$${target} "; \
651 fi; \
652 fi; \
653 done
654 @echo
656 ## targets-f3 : make all F3 targets
657 targets-f3:
658 $(V1) $(MAKE) -s targets-by-mcu MCU_TYPE=STM32F3 TARGETS="$(VALID_TARGETS)" DO_BUILD=1
660 targets-f3-print:
661 $(V1) $(MAKE) -s targets-by-mcu MCU_TYPE=STM32F3 TARGETS="$(VALID_TARGETS)"
663 ## targets-f4 : make all F4 targets
664 targets-f4:
665 $(V1) $(MAKE) -s targets-by-mcu MCU_TYPE=STM32F4 TARGETS="$(VALID_TARGETS)" DO_BUILD=1
667 targets-f4-print:
668 $(V1) $(MAKE) -s targets-by-mcu MCU_TYPE=STM32F4 TARGETS="$(VALID_TARGETS)"
670 targets-ci-f4-print:
671 $(V1) $(MAKE) -s targets-by-mcu MCU_TYPE=STM32F4 TARGETS="$(CI_TARGETS)"
673 ## targets-f7 : make all F7 targets
674 targets-f7:
675 $(V1) $(MAKE) -s targets-by-mcu MCU_TYPE=STM32F7 TARGETS="$(VALID_TARGETS)" DO_BUILD=1
677 targets-f7-print:
678 $(V1) $(MAKE) -s targets-by-mcu MCU_TYPE=STM32F7 TARGETS="$(VALID_TARGETS)"
680 targets-ci-f7-print:
681 $(V1) $(MAKE) -s targets-by-mcu MCU_TYPE=STM32F7 TARGETS="$(CI_TARGETS)"
683 ## test : run the Betaflight test suite
684 ## junittest : run the Betaflight test suite, producing Junit XML result files.
685 ## test-representative: run a representative subset of the Betaflight test suite (i.e. run all tests, but run each expanded test only for one target)
686 ## test-all: run the Betaflight test suite including all per-target expanded tests
687 test junittest test-all test-representative:
688 $(V0) cd src/test && $(MAKE) $@
690 ## test_help : print the help message for the test suite (including a list of the available tests)
691 test_help:
692 $(V0) cd src/test && $(MAKE) help
694 ## test_versions : print the compiler versions used for the test suite
695 test_versions:
696 $(V0) cd src/test && $(MAKE) versions
698 ## test_% : run test 'test_%' from the test suite
699 test_%:
700 $(V0) cd src/test && $(MAKE) $@
703 # rebuild everything when makefile changes
704 $(TARGET_OBJS): Makefile $(TARGET_DIR)/target.mk $(wildcard make/*)
706 # include auto-generated dependencies
707 -include $(TARGET_DEPS)