Makefile

   1 #
   2 # Top level Makefile for the LibrePilot Project build system.
   3 # Copyright (c) 2015, The LibrePilot Project, http://www.librepilot.org
   4 # Copyright (c) 2010-2013, The OpenPilot Team, http://www.openpilot.org
   5 # Use 'make help' for instructions.
   6 #
   7 # This program is free software; you can redistribute it and/or modify
   8 # it under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # This program is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  14 # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  15 # for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License along
  18 # with this program; if not, write to the Free Software Foundation, Inc.,
  19 # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  20 #
  21
  22 # This top level Makefile passes down some variables to sub-makes through
  23 # the environment. They are explicitly exported using the export keyword.
  24 # Lower level makefiles assume that these variables are defined. To ensure
  25 # that a special magic variable is exported here. It must be checked for
  26 # existance by each sub-make.
  27 export TOP_LEVEL_MAKEFILE := TRUE
  28
  29 # The root directory that this makefile resides in
  30 export ROOT_DIR := $(realpath $(dir $(lastword $(MAKEFILE_LIST))))
  31
  32 # Include some helper functions
  33 include $(ROOT_DIR)/make/functions.mk
  34
  35 # This file can be used to override default options using the "override" keyword
  36 CONFIG_FILE := config
  37 -include $(CONFIG_FILE)
  38
  39 ##############################
  40 # It is possible to set DL_DIR and/or TOOLS_DIR environment
  41 # variables to override local tools download and installation directorys. So the
  42 # same toolchains can be used for all working copies. Particularly useful for CI
  43 # server build agents, but also for local installations.
  44 override DL_DIR    := $(if $(DL_DIR),$(call slashfix,$(DL_DIR)),$(ROOT_DIR)/downloads)
  45 override TOOLS_DIR := $(if $(TOOLS_DIR),$(call slashfix,$(TOOLS_DIR)),$(ROOT_DIR)/tools)
  46 export DL_DIR
  47 export TOOLS_DIR
  48
  49 # Set up some macros for common directories within the tree
  50 export BUILD_DIR     := $(CURDIR)/build
  51 export PACKAGE_DIR   := $(BUILD_DIR)/package
  52 export DIST_DIR      := $(BUILD_DIR)/dist
  53 export OPGCSSYNTHDIR := $(BUILD_DIR)/gcs-synthetics
  54
  55 DIRS := $(DL_DIR) $(TOOLS_DIR) $(BUILD_DIR) $(PACKAGE_DIR) $(DIST_DIR) $(OPGCSSYNTHDIR)
  56
  57 # Naming for binaries and packaging etc,.
  58 export ORG_BIG_NAME := LibrePilot
  59 GCS_LABEL := GCS
  60 GCS_BIG_NAME := $(ORG_BIG_NAME) $(GCS_LABEL)
  61 # These should be lowercase with no spaces
  62 export ORG_SMALL_NAME := $(call smallify,$(ORG_BIG_NAME))
  63 GCS_SMALL_NAME := $(call smallify,$(GCS_BIG_NAME))
  64
  65 WEBSITE_URL      := http://librepilot.org
  66 GIT_URL          := https://bitbucket.org/librepilot/librepilot.git
  67 GITWEB_URL       := https://bitbucket.org/librepilot/librepilot
  68 # Change this once the DNS is set to http://wiki.librepilot.org/
  69 WIKI_URL_ROOT    := https://librepilot.atlassian.net/wiki/display/LPDOC/
  70 USAGETRACKER_URL := https://usagetracker.librepilot.org/
  71
  72 PACKAGING_EMAIL_ADDRESS := packaging@librepilot.org
  73
  74 define DESCRIPTION_SHORT :=
  75 A ground control station and firmware for UAV flight controllers
  76 endef
  77
  78 define DESCRIPTION_LONG :=
  79 The LibrePilot open source project was founded in July 2015.
  80 It focuses on research and development of software and hardware to be used in a variety of applications including vehicle control and stabilization, unmanned autonomous vehicles and robotics.
  81 One of the project’s primary goals is to provide an open and collaborative environment making it the ideal home for development of innovative ideas.
  82 endef
  83
  84
  85 # Clean out undesirable variables from the environment and command-line
  86 # to remove the chance that they will cause problems with our build
  87 define SANITIZE_VAR
  88 $(if $(filter-out undefined,$(origin $(1))),
  89     $(info $(EMPTY) NOTE        Sanitized $(2) variable '$(1)' from $(origin $(1)))
  90     MAKEOVERRIDES = $(filter-out $(1)=%,$(MAKEOVERRIDES))
  91     override $(1) :=
  92     unexport $(1)
  93 )
  94 endef
  95
  96 # These specific variables can influence compilation in unexpected (and undesirable) ways
  97 # gcc flags
  98 SANITIZE_GCC_VARS := TMPDIR GCC_EXEC_PREFIX COMPILER_PATH LIBRARY_PATH
  99 # preprocessor flags
 100 SANITIZE_GCC_VARS += CPATH C_INCLUDE_PATH CPLUS_INCLUDE_PATH OBJC_INCLUDE_PATH DEPENDENCIES_OUTPUT
 101 # make flags
 102 SANITIZE_GCC_VARS += CFLAGS CXXFLAGS CPPFLAGS LDFLAGS LDLIBS
 103 $(foreach var, $(SANITIZE_GCC_VARS), $(eval $(call SANITIZE_VAR,$(var),disallowed)))
 104
 105 # These specific variables used to be valid but now they make no sense
 106 SANITIZE_DEPRECATED_VARS := USE_BOOTLOADER CLEAN_BUILD
 107 $(foreach var, $(SANITIZE_DEPRECATED_VARS), $(eval $(call SANITIZE_VAR,$(var),deprecated)))
 108
 109 # Make sure this isn't being run as root unless installing (no whoami on Windows, but that is ok here)
 110 ifeq ($(shell whoami 2>/dev/null),root)
 111     ifeq ($(filter install uninstall,$(MAKECMDGOALS)),)
 112         ifndef FAKEROOTKEY
 113             $(error You should not be running this as root)
 114         endif
 115     endif
 116 endif
 117
 118 # Decide on a verbosity level based on the V= parameter
 119 export AT := @
 120 ifndef V
 121     export V0    :=
 122     export V1    := $(AT)
 123 else ifeq ($(V), 0)
 124     export V0    := $(AT)
 125     export V1    := $(AT)
 126 else ifeq ($(V), 1)
 127 endif
 128
 129 ARCH := $(call get_arch)
 130
 131 # Include tools installers
 132 include $(ROOT_DIR)/make/tools.mk
 133
 134 # Include third party builders if available
 135 -include $(ROOT_DIR)/make/3rdparty/3rdparty.mk
 136
 137 # We almost need to consider autoconf/automake instead of this
 138 ifeq ($(UNAME), Linux)
 139     UAVOBJGENERATOR := $(BUILD_DIR)/uavobjgenerator/uavobjgenerator
 140 else ifeq ($(UNAME), Darwin)
 141     UAVOBJGENERATOR := $(BUILD_DIR)/uavobjgenerator/uavobjgenerator
 142 else ifeq ($(UNAME), Windows)
 143     UAVOBJGENERATOR := $(BUILD_DIR)/uavobjgenerator/uavobjgenerator.exe
 144 endif
 145
 146 export UAVOBJGENERATOR
 147
 148 # Set up default build configurations (debug | release)
 149 GCS_BUILD_CONF := release
 150
 151 # Set extra configuration
 152 GCS_EXTRA_CONF += osg copy_osg
 153
 154 ##############################
 155 #
 156 # All targets
 157 #
 158 ##############################
 159
 160 .PHONY: all
 161 all: uavobjects all_ground all_flight
 162
 163 .PHONY: all_clean
 164 all_clean:
 165         @$(ECHO) " CLEAN      $(call toprel, $(BUILD_DIR))"
 166         $(V1) [ ! -d "$(BUILD_DIR)" ] || $(RM) -rf "$(BUILD_DIR)"
 167
 168 .PHONY: clean
 169 clean: all_clean
 170
 171
 172 ##############################
 173 #
 174 # UAVObjects
 175 #
 176 ##############################
 177
 178 UAVOBJGENERATOR_DIR := $(BUILD_DIR)/uavobjgenerator
 179 DIRS += $(UAVOBJGENERATOR_DIR)
 180
 181 .PHONY: uavobjgenerator
 182 uavobjgenerator: $(UAVOBJGENERATOR)
 183
 184 $(UAVOBJGENERATOR): | $(UAVOBJGENERATOR_DIR)
 185         $(V1) cd $(UAVOBJGENERATOR_DIR) && \
 186             ( [ -f Makefile ] || $(QMAKE) $(ROOT_DIR)/ground/uavobjgenerator/uavobjgenerator.pro \
 187             CONFIG+='$(GCS_BUILD_CONF) $(GCS_EXTRA_CONF)' ) && \
 188             $(MAKE) --no-print-directory -w
 189
 190 UAVOBJ_TARGETS := gcs flight python matlab java wireshark
 191
 192 .PHONY: uavobjects
 193 uavobjects:  $(addprefix uavobjects_, $(UAVOBJ_TARGETS))
 194
 195 UAVOBJ_XML_DIR := $(ROOT_DIR)/shared/uavobjectdefinition
 196 UAVOBJ_OUT_DIR := $(BUILD_DIR)/uavobject-synthetics
 197
 198 uavobjects_%: $(UAVOBJGENERATOR)
 199         @$(MKDIR) -p $(UAVOBJ_OUT_DIR)/$*
 200         $(V1) ( cd $(UAVOBJ_OUT_DIR)/$* && \
 201             $(UAVOBJGENERATOR) -$* $(UAVOBJ_XML_DIR) $(ROOT_DIR) ; \
 202         )
 203
 204 uavobjects_test: $(UAVOBJGENERATOR)
 205         $(V1) $(UAVOBJGENERATOR) -v $(UAVOBJ_XML_DIR) $(ROOT_DIR)
 206
 207 uavobjects_clean:
 208         @$(ECHO) " CLEAN      $(call toprel, $(UAVOBJ_OUT_DIR))"
 209         $(V1) [ ! -d "$(UAVOBJ_OUT_DIR)" ] || $(RM) -r "$(UAVOBJ_OUT_DIR)"
 210
 211 ##############################
 212 #
 213 # Flight related components
 214 #
 215 ##############################
 216
 217
 218 # When building any of the "all_*" targets, tell all sub makefiles to display
 219 # additional details on each line of output to describe which build and target
 220 # that each line applies to. The same applies also to all, opfw_resource,
 221 # package targets
 222 ifneq ($(strip $(filter all_% all opfw_resource package,$(MAKECMDGOALS))),)
 223     export ENABLE_MSG_EXTRA := yes
 224 endif
 225
 226 # When building more than one goal in a single make invocation, also
 227 # enable the extra context for each output line
 228 ifneq ($(word 2,$(MAKECMDGOALS)),)
 229     export ENABLE_MSG_EXTRA := yes
 230 endif
 231
 232 FLIGHT_OUT_DIR := $(BUILD_DIR)/firmware
 233 DIRS += $(FLIGHT_OUT_DIR)
 234
 235 include $(ROOT_DIR)/flight/Makefile
 236
 237 ##############################
 238 #
 239 # GCS related components
 240 #
 241 ##############################
 242
 243 .PHONY: all_ground
 244 all_ground: gcs uploader
 245
 246 ifneq ($(V), 1)
 247     GCS_EXTRA_CONF += silent
 248 endif
 249
 250 GCS_DIR := $(BUILD_DIR)/$(GCS_SMALL_NAME)_$(GCS_BUILD_CONF)
 251 DIRS += $(GCS_DIR)
 252
 253 GCS_MAKEFILE := $(GCS_DIR)/Makefile
 254
 255 .PHONY: gcs_qmake
 256 gcs_qmake $(GCS_MAKEFILE): | $(GCS_DIR)
 257         $(V1) cd $(GCS_DIR) && \
 258             $(QMAKE) $(ROOT_DIR)/ground/gcs/gcs.pro \
 259             -r CONFIG+='$(GCS_BUILD_CONF) $(GCS_EXTRA_CONF)' \
 260             'GCS_BIG_NAME="$(GCS_BIG_NAME)"' GCS_SMALL_NAME=$(GCS_SMALL_NAME) \
 261             'ORG_BIG_NAME="$(ORG_BIG_NAME)"' ORG_SMALL_NAME=$(ORG_SMALL_NAME) \
 262             'WIKI_URL_ROOT="$(WIKI_URL_ROOT)"' \
 263             'USAGETRACKER_URL="$(USAGETRACKER_URL)"' \
 264             'GCS_LIBRARY_BASENAME=$(libbasename)' \
 265             $(GCS_QMAKE_OPTS)
 266
 267 .PHONY: gcs
 268 gcs: $(UAVOBJGENERATOR) $(GCS_MAKEFILE)
 269         $(V1) $(MAKE) -w -C $(GCS_DIR)/$(MAKE_DIR);
 270
 271 .PHONY: gcs_clean
 272 gcs_clean:
 273         @$(ECHO) " CLEAN      $(call toprel, $(GCS_DIR))"
 274         $(V1) [ ! -d "$(GCS_DIR)" ] || $(RM) -r "$(GCS_DIR)"
 275
 276
 277
 278 ################################
 279 #
 280 # Serial Uploader tool
 281 #
 282 ################################
 283
 284 UPLOADER_DIR := $(BUILD_DIR)/uploader_$(GCS_BUILD_CONF)
 285 DIRS += $(UPLOADER_DIR)
 286
 287 UPLOADER_MAKEFILE := $(UPLOADER_DIR)/Makefile
 288
 289 .PHONY: uploader_qmake
 290 uploader_qmake $(UPLOADER_MAKEFILE): | $(UPLOADER_DIR)
 291         $(V1) cd $(UPLOADER_DIR) && \
 292             $(QMAKE) $(ROOT_DIR)/ground/gcs/src/experimental/USB_UPLOAD_TOOL/upload.pro \
 293             -r CONFIG+='$(GCS_BUILD_CONF) $(GCS_EXTRA_CONF)' $(GCS_QMAKE_OPTS)
 294
 295 .PHONY: uploader
 296 uploader: $(UPLOADER_MAKEFILE)
 297         $(V1) $(MAKE) -w -C $(UPLOADER_DIR)
 298
 299 .PHONY: uploader_clean
 300 uploader_clean:
 301         @$(ECHO) " CLEAN      $(call toprel, $(UPLOADER_DIR))"
 302         $(V1) [ ! -d "$(UPLOADER_DIR)" ] || $(RM) -r "$(UPLOADER_DIR)"
 303
 304
 305
 306 ##############################
 307 #
 308 # Packaging components
 309 #
 310 ##############################
 311 # Firmware files to package
 312 PACKAGE_FW_TARGETS := fw_coptercontrol fw_oplinkmini fw_revolution fw_osd fw_revoproto fw_gpsplatinum fw_revonano
 313
 314 # Rules to generate GCS resources used to embed firmware binaries into the GCS.
 315 # They are used later by the vehicle setup wizard to update board firmware.
 316 # To open a firmware image use ":/firmware/fw_coptercontrol.opfw"
 317 OPFW_RESOURCE := $(OPGCSSYNTHDIR)/opfw_resource.qrc
 318
 319 ifeq ($(WITH_PREBUILT_FW),)
 320 FIRMWARE_DIR := $(FLIGHT_OUT_DIR)
 321 # We need to build the FW targets
 322 $(OPFW_RESOURCE): $(PACKAGE_FW_TARGETS)
 323 else
 324 FIRMWARE_DIR := $(WITH_PREBUILT_FW)
 325 endif
 326
 327 OPFW_FILES := $(foreach fw_targ, $(PACKAGE_FW_TARGETS), $(FIRMWARE_DIR)/$(fw_targ)/$(fw_targ).opfw)
 328 OPFW_CONTENTS := \
 329 <!DOCTYPE RCC><RCC version="1.0"> \
 330     <qresource prefix="/firmware"> \
 331         $(foreach fw_file, $(OPFW_FILES), <file alias="$(notdir $(fw_file))">$(call system_path,$(fw_file))</file>) \
 332     </qresource> \
 333 </RCC>
 334
 335 .PHONY: opfw_resource
 336 opfw_resource: $(OPFW_RESOURCE)
 337
 338 $(OPFW_RESOURCE): | $(OPGCSSYNTHDIR)
 339         @$(ECHO) Generating OPFW resource file $(call toprel, $@)
 340         $(V1) $(ECHO) $(QUOTE)$(OPFW_CONTENTS)$(QUOTE) > $@
 341
 342 # If opfw_resource or all firmware are requested, GCS should depend on the resource
 343 ifneq ($(strip $(filter opfw_resource all all_fw all_flight package,$(MAKECMDGOALS))),)
 344 $(GCS_MAKEFILE): $(OPFW_RESOURCE)
 345 endif
 346
 347 # Packaging targets: package
 348 #  - builds all firmware, opfw_resource, gcs
 349 #  - copies firmware into a package directory
 350 #  - calls paltform-specific packaging script
 351
 352 # Define some variables
 353 PACKAGE_LBL       := $(shell $(VERSION_INFO) --format=\$${LABEL})
 354 PACKAGE_NAME      := $(subst $(SPACE),,$(ORG_BIG_NAME))
 355 PACKAGE_SEP       := -
 356 PACKAGE_FULL_NAME := $(PACKAGE_NAME)$(PACKAGE_SEP)$(PACKAGE_LBL)
 357
 358 # Source distribution is never dirty because it uses git archive
 359 DIST_LBL       := $(subst -dirty,,$(PACKAGE_LBL))
 360 DIST_NAME      := $(PACKAGE_NAME)$(PACKAGE_SEP)$(DIST_LBL)
 361 DIST_TAR       := $(DIST_DIR)/$(DIST_NAME).tar
 362 DIST_TAR_GZ    := $(DIST_TAR).gz
 363 FW_DIST_NAME   := $(DIST_NAME)_firmware
 364 FW_DIST_TAR    := $(DIST_DIR)/$(FW_DIST_NAME).tar
 365 FW_DIST_TAR_GZ := $(FW_DIST_TAR).gz
 366 DIST_VER_INFO  := $(DIST_DIR)/version-info.json
 367
 368 include $(ROOT_DIR)/package/$(UNAME).mk
 369
 370 ##############################
 371 #
 372 # Source for distribution
 373 #
 374 ##############################
 375 $(DIST_VER_INFO): .git/index | $(DIST_DIR)
 376         $(V1) $(VERSION_INFO) --jsonpath="$(DIST_DIR)"
 377
 378 $(DIST_TAR): $(DIST_VER_INFO) .git/index | $(DIST_DIR)
 379         @$(ECHO) " SOURCE FOR DISTRIBUTION $(call toprel, $(DIST_TAR))"
 380         $(V1) git archive --prefix="$(PACKAGE_NAME)/" -o "$(DIST_TAR)" HEAD
 381         $(V1) tar --append --file="$(DIST_TAR)" \
 382                 --transform='s,.*version-info.json,$(PACKAGE_NAME)/version-info.json,' \
 383                 $(call toprel, "$(DIST_VER_INFO)")
 384
 385 $(DIST_TAR_GZ): $(DIST_TAR)
 386         @$(ECHO) " SOURCE FOR DISTRIBUTION $(call toprel, $(DIST_TAR_GZ))"
 387         $(V1) gzip -kf "$(DIST_TAR)"
 388
 389 .PHONY: dist_tar_gz
 390 dist_tar_gz: $(DIST_TAR_GZ)
 391
 392 .PHONY: dist
 393 dist: dist_tar_gz
 394
 395
 396 $(FW_DIST_TAR): $(PACKAGE_FW_TARGETS) | $(DIST_DIR)
 397         @$(ECHO) " FIRMWARE FOR DISTRIBUTION $(call toprel, $(FW_DIST_TAR))"
 398         $(V1) tar -c --file="$(FW_DIST_TAR)" --directory=$(FLIGHT_OUT_DIR) \
 399                 --transform='s,^,firmware/,' \
 400                 $(foreach fw_targ,$(PACKAGE_FW_TARGETS),$(fw_targ)/$(fw_targ).opfw)
 401
 402 $(FW_DIST_TAR_GZ): $(FW_DIST_TAR)
 403         @$(ECHO) " FIRMWARE FOR DISTRIBUTION $(call toprel, $(FW_DIST_TAR_GZ))"
 404         $(V1) gzip -kf "$(FW_DIST_TAR)"
 405
 406 .PHONY: fw_dist_tar_gz
 407 fw_dist_tar_gz: $(FW_DIST_TAR_GZ)
 408
 409 .PHONY: fw_dist
 410 fw_dist: fw_dist_tar_gz
 411
 412
 413 ##############################
 414 #
 415 # Source code formatting
 416 #
 417 ##############################
 418
 419 UNCRUSTIFY_TARGETS := flight ground
 420
 421 # $(1) = Uncrustify target (e.g flight or ground)
 422 # $(2) = Target root directory
 423 define UNCRUSTIFY_TEMPLATE
 424
 425 .PHONY: uncrustify_$(1)
 426 uncrustify_$(1):
 427         @$(ECHO) "Auto-formatting $(1) source code"
 428         $(V1) UNCRUSTIFY_CONFIG="$(ROOT_DIR)/make/uncrustify/uncrustify.cfg" $(SHELL) make/scripts/uncrustify.sh $(call toprel, $(2))
 429 endef
 430
 431 $(foreach uncrustify_targ, $(UNCRUSTIFY_TARGETS), $(eval $(call UNCRUSTIFY_TEMPLATE,$(uncrustify_targ),$(ROOT_DIR)/$(uncrustify_targ))))
 432
 433 .PHONY: uncrustify_all
 434 uncrustify_all: $(addprefix uncrustify_,$(UNCRUSTIFY_TARGETS))
 435
 436 ##############################
 437 #
 438 # Doxygen documentation
 439 #
 440 # Each target should have own Doxyfile.$(target) with build directory build/docs/$(target),
 441 # proper source directory (e.g. $(target)) and appropriate other doxygen options.
 442 #
 443 ##############################
 444
 445 DOCS_TARGETS := flight ground uavobjects
 446
 447 # $(1) = Doxygen target (e.g flight or ground)
 448 define DOXYGEN_TEMPLATE
 449
 450 .PHONY: docs_$(1)
 451 docs_$(1): docs_$(1)_clean
 452         @$(ECHO) "Generating $(1) documentation"
 453         $(V1) $(MKDIR) -p $(BUILD_DIR)/docs/$(1)
 454         $(V1) $(DOXYGEN) $(ROOT_DIR)/make/doxygen/Doxyfile.$(1)
 455
 456 .PHONY: docs_$(1)_clean
 457 docs_$(1)_clean:
 458         @$(ECHO) " CLEAN      $(call toprel, $(BUILD_DIR)/docs/$(1))"
 459         $(V1) [ ! -d "$(BUILD_DIR)/docs/$(1)" ] || $(RM) -r "$(BUILD_DIR)/docs/$(1)"
 460
 461 endef
 462
 463 $(foreach docs_targ, $(DOCS_TARGETS), $(eval $(call DOXYGEN_TEMPLATE,$(docs_targ))))
 464
 465 .PHONY: docs_all
 466 docs_all: $(addprefix docs_,$(DOCS_TARGETS))
 467
 468 .PHONY: docs_all_clean
 469 docs_all_clean:
 470         @$(ECHO) " CLEAN      $(call toprel, $(BUILD_DIR)/docs)"
 471         $(V1) [ ! -d "$(BUILD_DIR)/docs" ] || $(RM) -rf "$(BUILD_DIR)/docs"
 472
 473 ##############################
 474 #
 475 # Build info
 476 #
 477 ##############################
 478
 479 .PHONY: build-info
 480 build-info: | $(BUILD_DIR)
 481         @$(ECHO) " BUILD-INFO $(call toprel, $(BUILD_DIR)/$@.txt)"
 482         $(V1) $(VERSION_INFO) \
 483                 --uavodir=$(ROOT_DIR)/shared/uavobjectdefinition \
 484                 --template="make/templates/$@.txt" \
 485                 --outfile="$(BUILD_DIR)/$@.txt"
 486
 487 ##############################
 488 #
 489 # Config
 490 #
 491 ##############################
 492
 493 CONFIG_OPTS := $(addsuffix \n,$(MAKEOVERRIDES))
 494 CONFIG_OPTS := $(addprefix override$(SPACE),$(CONFIG_OPTS))
 495
 496 .PHONY: config_new
 497 config_new:
 498         @printf '$(CONFIG_OPTS)' > $(CONFIG_FILE)
 499
 500 .PHONY: config_append
 501 config_append:
 502         @printf '$(CONFIG_OPTS)' >> $(CONFIG_FILE)
 503
 504 .PHONY: config_show
 505 config_show:
 506         @cat $(CONFIG_FILE)
 507
 508 .PHONY: config_clean
 509 config_clean:
 510         rm -f $(CONFIG_FILE)
 511
 512
 513 ##############################
 514 #
 515 # Directories
 516 #
 517 ##############################
 518
 519 $(DIRS):
 520         $(V1) $(MKDIR) -p $@
 521
 522
 523 ##############################
 524 #
 525 # Help message, the default Makefile goal
 526 #
 527 ##############################
 528
 529 .DEFAULT_GOAL := help
 530
 531 .PHONY: help
 532 help:
 533         @$(ECHO)
 534         @$(ECHO) "   This Makefile is known to work on Linux and Mac in a standard shell environment."
 535         @$(ECHO) "   It also works on Windows by following the instructions given on this wiki page:"
 536         @$(ECHO) "       $(WIKI_ROOT_URL)Windows+Building+and+Packaging"
 537         @$(ECHO)
 538         @$(ECHO) "   Here is a summary of the available targets:"
 539         @$(ECHO)
 540         @$(ECHO) "   [Source tree preparation]"
 541         @$(ECHO) "     prepare              - Install GIT commit message template"
 542         @$(ECHO) "   [Tool Installers]"
 543         @$(ECHO) "     arm_sdk_install      - Install the GNU ARM gcc toolchain"
 544         @$(ECHO) "     qt_sdk_install       - Install the QT development tools"
 545         @$(ECHO) "     nsis_install         - Install the NSIS Unicode (Windows only)"
 546         @$(ECHO) "     mesawin_install      - Install the OpenGL32 DLL (Windows only)"
 547         @$(ECHO) "     uncrustify_install   - Install the Uncrustify source code beautifier"
 548         @$(ECHO) "     doxygen_install      - Install the Doxygen documentation generator"
 549         @$(ECHO) "     gtest_install        - Install the GoogleTest framework"
 550         @$(ECHO) "     ccache_install       - Install ccache"
 551         @$(ECHO) "   These targets are not updated yet and are probably broken:"
 552         @$(ECHO) "     openocd_install      - Install the OpenOCD JTAG daemon"
 553         @$(ECHO) "     stm32flash_install   - Install the stm32flash tool for unbricking F1-based boards"
 554         @$(ECHO) "     dfuutil_install      - Install the dfu-util tool for unbricking F4-based boards"
 555         @$(ECHO) "   Install all available tools:"
 556         @$(ECHO) "     all_sdk_install      - Install all of above (platform-dependent)"
 557         @$(ECHO) "     build_sdk_install    - Install only essential for build tools (platform-dependent)"
 558         @$(ECHO)
 559         @$(ECHO) "   Other tool options are:"
 560         @$(ECHO) "     <tool>_version       - Display <tool> version"
 561         @$(ECHO) "     <tool>_clean         - Remove installed <tool>"
 562         @$(ECHO) "     <tool>_distclean     - Remove downloaded <tool> distribution file(s)"
 563         @$(ECHO)
 564         @$(ECHO) "   [Big Hammer]"
 565         @$(ECHO) "     all                  - Generate UAVObjects, build $(ORG_BIG_NAME) firmware and gcs"
 566         @$(ECHO) "     all_flight           - Build all firmware, bootloaders and bootloader updaters"
 567         @$(ECHO) "     all_fw               - Build only firmware for all boards"
 568         @$(ECHO) "     all_bl               - Build only bootloaders for all boards"
 569         @$(ECHO) "     all_bu               - Build only bootloader updaters for all boards"
 570         @$(ECHO)
 571         @$(ECHO) "     all_clean            - Remove your build directory ($(BUILD_DIR))"
 572         @$(ECHO) "     all_flight_clean     - Remove all firmware, bootloaders and bootloader updaters"
 573         @$(ECHO) "     all_fw_clean         - Remove firmware for all boards"
 574         @$(ECHO) "     all_bl_clean         - Remove bootloaders for all boards"
 575         @$(ECHO) "     all_bu_clean         - Remove bootloader updaters for all boards"
 576         @$(ECHO)
 577         @$(ECHO) "     all_<board>          - Build all available images for <board>"
 578         @$(ECHO) "     all_<board>_clean    - Remove all available images for <board>"
 579         @$(ECHO)
 580         @$(ECHO) "     all_ut               - Build all unit tests"
 581         @$(ECHO) "     all_ut_tap           - Run all unit tests and capture all TAP output to files"
 582         @$(ECHO) "     all_ut_run           - Run all unit tests and dump TAP output to console"
 583         @$(ECHO)
 584         @$(ECHO) "   [Firmware]"
 585         @$(ECHO) "     <board>              - Build firmware for <board>"
 586         @$(ECHO) "                            Supported boards are ($(ALL_BOARDS))"
 587         @$(ECHO) "     fw_<board>           - Build firmware for <board>"
 588         @$(ECHO) "                            Supported boards are ($(FW_BOARDS))"
 589         @$(ECHO) "     fw_<board>_clean     - Remove firmware for <board>"
 590         @$(ECHO) "     fw_<board>_program   - Use OpenOCD + JTAG to write firmware to <board>"
 591         @$(ECHO)
 592         @$(ECHO) "   [Bootloader]"
 593         @$(ECHO) "     bl_<board>           - Build bootloader for <board>"
 594         @$(ECHO) "                            Supported boards are ($(BL_BOARDS))"
 595         @$(ECHO) "     bl_<board>_clean     - Remove bootloader for <board>"
 596         @$(ECHO) "     bl_<board>_program   - Use OpenOCD + JTAG to write bootloader to <board>"
 597         @$(ECHO)
 598         @$(ECHO) "   [Entire Flash]"
 599         @$(ECHO) "     ef_<board>           - Build entire flash image for <board>"
 600         @$(ECHO) "                            Supported boards are ($(EF_BOARDS))"
 601         @$(ECHO) "     ef_<board>_clean     - Remove entire flash image for <board>"
 602         @$(ECHO) "     ef_<board>_program   - Use OpenOCD + JTAG to write entire flash image to <board>"
 603         @$(ECHO)
 604         @$(ECHO) "   [Bootloader Updater]"
 605         @$(ECHO) "     bu_<board>           - Build bootloader updater for <board>"
 606         @$(ECHO) "                            Supported boards are ($(BU_BOARDS))"
 607         @$(ECHO) "     bu_<board>_clean     - Remove bootloader updater for <board>"
 608         @$(ECHO)
 609         @$(ECHO) "   [Unbrick a board]"
 610         @$(ECHO) "     unbrick_<board>      - Use the STM32's built in boot ROM to write a bootloader to <board>"
 611         @$(ECHO) "                            Supported boards are ($(BL_BOARDS))"
 612         @$(ECHO) "   [Unittests]"
 613         @$(ECHO) "     ut_<test>            - Build unit test <test>"
 614         @$(ECHO) "     ut_<test>_xml        - Run test and capture XML output into a file"
 615         @$(ECHO) "     ut_<test>_run        - Run test and dump output to console"
 616         @$(ECHO)
 617         @$(ECHO) "   [Simulation]"
 618         @$(ECHO) "     sim_osx              - Build $(ORG_BIG_NAME) simulation firmware for OSX"
 619         @$(ECHO) "     sim_osx_clean        - Delete all build output for the osx simulation"
 620         @$(ECHO) "     sim_win32            - Build $(ORG_BIG_NAME) simulation firmware for Windows"
 621         @$(ECHO) "                            using mingw and msys"
 622         @$(ECHO) "     sim_win32_clean      - Delete all build output for the win32 simulation"
 623         @$(ECHO)
 624         @$(ECHO) "   [GCS]"
 625         @$(ECHO) "     gcs                  - Build the Ground Control System (GCS) application (debug|release)"
 626         @$(ECHO) "                            Compile specific directory: MAKE_DIR=<dir>"
 627         @$(ECHO) "                            Example: make gcs MAKE_DIR=src/plugins/coreplugin"
 628         @$(ECHO) "     gcs_qmake            - Run qmake for the Ground Control System (GCS) application (debug|release)"
 629         @$(ECHO) "     gcs_clean            - Remove the Ground Control System (GCS) application (debug|release)"
 630         @$(ECHO) "                            Supported build configurations: GCS_BUILD_CONF=debug|release (default is $(GCS_BUILD_CONF))"
 631         @$(ECHO)
 632         @$(ECHO) "   [Uploader Tool]"
 633         @$(ECHO) "     uploader             - Build the serial uploader tool (debug|release)"
 634         @$(ECHO) "     uploader_qmake       - Run qmake for the serial uploader tool (debug|release)"
 635         @$(ECHO) "     uploader_clean       - Remove the serial uploader tool (debug|release)"
 636         @$(ECHO) "                            Supported build configurations: GCS_BUILD_CONF=debug|release (default is $(GCS_BUILD_CONF))"
 637         @$(ECHO)
 638         @$(ECHO)
 639         @$(ECHO) "   [UAVObjects]"
 640         @$(ECHO) "     uavobjects           - Generate source files from the UAVObject definition XML files"
 641         @$(ECHO) "     uavobjects_test      - Parse xml-files - check for valid, duplicate ObjId's, ..."
 642         @$(ECHO) "     uavobjects_<group>   - Generate source files from a subset of the UAVObject definition XML files"
 643         @$(ECHO) "                            Supported groups are ($(UAVOBJ_TARGETS))"
 644         @$(ECHO)
 645         @$(ECHO) "   [Packaging]"
 646         @$(ECHO) "     package              - Build and package the platform-dependent package (no clean)"
 647         @$(ECHO) "     opfw_resource        - Generate resources to embed firmware binaries into the GCS"
 648         @$(ECHO) "     dist                 - Generate source archive for distribution"
 649         @$(ECHO) "     fw_dist              - Generate archive of firmware"
 650         @$(ECHO) "     install              - Install GCS to \"DESTDIR\" with prefix \"prefix\" (Linux only)"
 651         @$(ECHO)
 652         @$(ECHO) "   [Code Formatting]"
 653         @$(ECHO) "     uncrustify_<source>  - Reformat <source> code according to the project's standards"
 654         @$(ECHO) "                            Supported sources are ($(UNCRUSTIFY_TARGETS))"
 655         @$(ECHO) "     uncrustify_all       - Reformat all source code"
 656         @$(ECHO)
 657         @$(ECHO) "   [Code Documentation]"
 658         @$(ECHO) "     docs_<source>        - Generate HTML documentation for <source>"
 659         @$(ECHO) "                            Supported sources are ($(DOCS_TARGETS))"
 660         @$(ECHO) "     docs_all             - Generate HTML documentation for all"
 661         @$(ECHO) "     docs_<source>_clean  - Delete generated documentation for <source>"
 662         @$(ECHO) "     docs_all_clean       - Delete all generated documentation"
 663         @$(ECHO)
 664         @$(ECHO) "   [Configuration]"
 665         @$(ECHO) "     config_new           - Place your make arguments in the config file"
 666         @$(ECHO) "     config_append        - Place your make arguments in the config file but append"
 667         @$(ECHO) "     config_clean         - Removes the config file"
 668         @$(ECHO)
 669         @$(ECHO) "   Hint: Add V=1 to your command line to see verbose build output."
 670         @$(ECHO)
 671         @$(ECHO) "  Notes: All tool distribution files will be downloaded into $(DL_DIR)"
 672         @$(ECHO) "         All tools will be installed into $(TOOLS_DIR)"
 673         @$(ECHO) "         All build output will be placed in $(BUILD_DIR)"
 674         @$(ECHO)
 675         @$(ECHO) "  Tool download and install directories can be changed using environment variables:"
 676         @$(ECHO) "         DL_DIR        full path to downloads directory [downloads if not set]"
 677         @$(ECHO) "         TOOLS_DIR     full path to installed tools directory [tools if not set]"
 678         @$(ECHO) "  More info: $(WIKI_URL_ROOT)LibrePilot+Build+System+Overview"
 679         @$(ECHO)