Skip to content
Permalink
master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Go to file
 
 
Cannot retrieve contributors at this time
################################################################################
# \file Makefile
# \version 1.0
#
# \brief
# Top-level application make file.
#
################################################################################
# \copyright
# Copyright 2018-2024, Cypress Semiconductor Corporation (an Infineon company)
# SPDX-License-Identifier: Apache-2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
################################################################################
################################################################################
# Basic Configuration
################################################################################
# Type of ModusToolbox Makefile Options include:
#
# COMBINED -- Top Level Makefile usually for single standalone application
# APPLICATION -- Top Level Makefile usually for multi project application
# PROJECT -- Project Makefile under Application
#
MTB_TYPE=COMBINED
# Target board/hardware (BSP).
# To change the target, it is recommended to use the Library manager
# ('make library-manager' from command line), which will also update Eclipse IDE launch
# configurations.
TARGET=CY8CKIT-062S2-43012
# Name of application (used to derive name of final linked file).
#
# If APPNAME is edited, ensure to update or regenerate launch
# configurations for your IDE.
APPNAME=mtb-example-btstack-freertos-battery-server
# Name of toolchain to use. Options include:
#
# GCC_ARM -- GCC provided with ModusToolbox
# ARM -- ARM Compiler (must be installed separately)
# IAR -- IAR Compiler (must be installed separately)
#
# See also: CY_COMPILER_PATH below
TOOLCHAIN=GCC_ARM
# Default build configuration. Options include:
#
# Debug -- build with minimal optimizations, focus on debugging.
# Release -- build with full optimizations
# Custom -- build with custom configuration, set the optimization flag in CFLAGS
#
# If CONFIG is manually edited, ensure to update or regenerate launch configurations
# for your IDE.
CONFIG=Debug
# If set to "true" or "1", display full command-lines when building.
VERBOSE=
################################################################################
# Advanced Configuration
################################################################################
# Enable optional code that is ordinarily disabled by default.
#
# Available components depend on the specific targeted hardware and firmware
# in use. In general, if you have
#
# COMPONENTS=foo bar
#
# ... then code in directories named COMPONENT_foo and COMPONENT_bar will be
# added to the build
#
COMPONENTS= FREERTOS PSOC6HAL WICED_BLE OTA_BLUETOOTH
# Like COMPONENTS, but disable optional code that was enabled by default.
DISABLE_COMPONENTS=
# By default the build system automatically looks in the Makefile's directory
# tree for source code and builds it. The SOURCES variable can be used to
# manually add source code to the build process from a location not searched
# by default, or otherwise not found by the build system.
SOURCES=
# Like SOURCES, but for include directories. Value should be paths to
# directories (without a leading -I).
INCLUDES=./configs
# Add additional defines to the build process (without a leading -D).
DEFINES+=CY_RETARGET_IO_CONVERT_LF_TO_CRLF CY_RTOS_AWARE
# Select softfp or hardfp floating point. Default is softfp.
VFP_SELECT=
# Additional / custom C compiler flags.
#
# NOTE: Includes and defines should use the INCLUDES and DEFINES variable
# above.
CFLAGS=
# Additional / custom C++ compiler flags.
#
# NOTE: Includes and defines should use the INCLUDES and DEFINES variable
# above.
CXXFLAGS=
# Additional / custom assembler flags.
#
# NOTE: Includes and defines should use the INCLUDES and DEFINES variable
# above.
ASFLAGS=
# Additional / custom linker flags.
LDFLAGS=
# Additional / custom libraries to link in to the application.
LDLIBS=
# Custom pre-build commands to run.
PREBUILD=
# Custom post-build commands to run.
POSTBUILD=
# Enable OTA by default for other supported kits
OTA_SUPPORT=1
# This code example supports BT transport only
# Excluding libraries needed for WiFi based transports
CY_IGNORE+=$(SEARCH_aws-iot-device-sdk-embedded-C)
CY_IGNORE+=$(SEARCH_aws-iot-device-sdk-port)
CY_IGNORE+=$(SEARCH_cy-mbedtls-acceleration)
CY_IGNORE+=$(SEARCH_http-client)
CY_IGNORE+=$(SEARCH_mqtt)
CY_IGNORE+=$(SEARCH_secure-sockets)
CY_IGNORE+=$(SEARCH_wifi-connection-manager)
CY_IGNORE+=$(SEARCH_lwip)
CY_IGNORE+=$(SEARCH_lwip-network-interface-integration)
CY_IGNORE+=$(SEARCH_lwip-freertos-integration)
CY_IGNORE+=$(SEARCH_mbedtls)
CY_IGNORE+=$(SEARCH_wifi-host-driver)
CY_IGNORE+=$(SEARCH_wifi-mw-core)
CY_IGNORE+=$(SEARCH_whd-bsp-integration)
CY_IGNORE+=$(SEARCH_wpa3-external-supplicant)
###############################################################################
#
# OTA Functionality Set up and support
#
###############################################################################
ifeq ($(OTA_SUPPORT),1)
#Select the core for the current application
CORE?=CM4
#Ignore Non-OTA code
CY_IGNORE+=./non_ota_source
# OTA / MCUBoot defines
# Defines to enable OTA over HTTP,MQTT and BT
# We support BT for this Application
OTA_HTTP_SUPPORT=0
OTA_MQTT_SUPPORT=0
OTA_BT_SUPPORT=1
# Component for adding platform-specific code
# ex: source/port_support/mcuboot/COMPONENT_OTA_PSOC_062/flash_qspi/flash_qspi.c
COMPONENTS+=OTA_PSOC_062
# Set Platform type and OTA flash map (added to defines and used when finding the linker script)
# Ex: PSOC_062_2M, PSOC_062_1M, PSOC_062_512K
ifeq ($(TARGET), $(filter $(TARGET), APP_CY8CPROTO-062-4343W APP_CY8CKIT-062S2-43012 APP_CY8CEVAL-062S2-LAI-4373M2 APP_CY8CEVAL-062S2-MUR-43439M2 APP_CY8CEVAL-062S2-CYW43022CUB))
OTA_PLATFORM=PSOC_062_2M
OTA_FLASH_MAP?=$(SEARCH_ota-update)/configs/flashmap/psoc62_2m_ext_swap_single.json
else ifeq ($(TARGET), APP_CY8CKIT-062-BLE)
OTA_PLATFORM=PSOC_062_1M
COMPONENTS+=CM0P_BLESS_OTA
DISABLE_COMPONENTS+=CM0P_BLESS
OTA_FLASH_MAP?=$(SEARCH_ota-update)/configs/flashmap/psoc62_1m_cm0_int_swap_single.json
else ifeq ($(TARGET), $(filter $(TARGET), APP_CY8CPROTO-063-BLE APP_CYBLE-416045-EVAL))
OTA_PLATFORM=PSOC_063_1M
COMPONENTS+=CM0P_BLESS_OTA
DISABLE_COMPONENTS+=CM0P_BLESS
OTA_FLASH_MAP?=$(SEARCH_ota-update)/configs/flashmap/psoc63_1m_cm0_int_swap_single.json
else ifeq ($(TARGET), $(filter $(TARGET), APP_CY8CPROTO-062S3-4343W))
OTA_PLATFORM=PSOC_062_512K
OTA_FLASH_MAP?=$(SEARCH_ota-update)/configs/flashmap/psoc62_512k_xip_swap_single.json
endif
# Change the Application version here or over-ride by setting an environment variable
# before building the application.
#
# export APP_VERSION_MAJOR=2
#
OTA_APP_VERSION_MAJOR?=5
OTA_APP_VERSION_MINOR?=0
OTA_APP_VERSION_BUILD?=0
# Build location local to this root directory.
CY_BUILD_LOC:=./build
# MCUBootApp header is added during signing step in POSTBUILD (sign_script.bash)
MCUBOOT_HEADER_SIZE=0x400
# Internal and external flash erased values used during signing step in POSTBUILD (sign_script.bash)
CY_INTERNAL_FLASH_ERASE_VALUE=0x00
CY_EXTERNAL_FLASH_ERASE_VALUE=0xFF
# Application MUST provide a flash map
ifneq ($(MAKECMDGOALS),getlibs)
ifneq ($(MAKECMDGOALS),get_app_info)
ifeq ($(OTA_FLASH_MAP),)
$(info "")
$(error Application makefile must define OTA_FLASH_MAP. For more info, see <ota-update>/configs/flashmap/MCUBoot_Build_Commands.md)
$(info "")
endif
endif
# For testing SWAP / REVERT
ifeq ($(TEST_SWAP_SETUP),1)
DEFINES+=TEST_SWAP_SETUP=1
endif
ifeq ($(TEST_SWAP_REVERT),1)
DEFINES+=TEST_SWAP_REVERT=1
endif
endif
# Add OTA_PLATFORM in DEFINES for platform-specific code
# ex: source/port_support/mcuboot/COMPONENT_OTA_PSOC_062/flash_qspi/flash_qspi.c
DEFINES+=$(OTA_PLATFORM)
# for use when running flashmap.py
FLASHMAP_PLATFORM=$(OTA_PLATFORM)
FLASHMAP_PYTHON_SCRIPT=flashmap.py
flash_map_mk_exists=$(shell if [ -s "flashmap.mk" ]; then echo "success"; fi )
ifneq ($(flash_map_mk_exists),)
$(info include flashmap.mk)
include ./flashmap.mk
endif # flash_map_mk_exists
############################
# IF FLASH_MAP sets USE_XIP,
# we are executing code
# from external flash
############################
ifeq ($(USE_XIP),1)
# We need to set this flag for executing code from external flash
CY_RUN_CODE_FROM_XIP=1
# If code resides in external flash, we must support external flash.
USE_EXTERNAL_FLASH=1
# When running from external flash
# Signal to /source/port_support/serial_flash/ota_serial_flash.c
# That we need to turn off XIP and enter critical section when accessing SMIF.
CY_XIP_SMIF_MODE_CHANGE=1
# Since we are running hybrid (some in RAM, some in External FLash),
# we need to override the WEAK functions in CYHAL
DEFINES+=CYHAL_DISABLE_WEAK_FUNC_IMPL=1
endif # USE_XIP
ifeq ($(FLASH_AREA_IMG_1_SECONDARY_DEV_ID),FLASH_DEVICE_INTERNAL_FLASH)
FLASH_ERASE_SECONDARY_SLOT_VALUE= $(CY_INTERNAL_FLASH_ERASE_VALUE)
else
FLASH_ERASE_SECONDARY_SLOT_VALUE= $(CY_EXTERNAL_FLASH_ERASE_VALUE)
endif # SECONDARY_DEV_ID
###################################
# Add OTA defines to build
###################################
DEFINES+=\
OTA_SUPPORT=1 \
APP_VERSION_MAJOR=$(OTA_APP_VERSION_MAJOR)\
APP_VERSION_MINOR=$(OTA_APP_VERSION_MINOR)\
APP_VERSION_BUILD=$(OTA_APP_VERSION_BUILD)
###################################
# The Defines from the flashmap.mk
###################################
DEFINES+=\
MCUBOOT_MAX_IMG_SECTORS=$(MCUBOOT_MAX_IMG_SECTORS)\
MCUBOOT_IMAGE_NUMBER=$(MCUBOOT_IMAGE_NUMBER)\
FLASH_AREA_BOOTLOADER_DEV_ID="$(FLASH_AREA_BOOTLOADER_DEV_ID)"\
FLASH_AREA_BOOTLOADER_START=$(FLASH_AREA_BOOTLOADER_START)\
FLASH_AREA_BOOTLOADER_SIZE=$(FLASH_AREA_BOOTLOADER_SIZE)\
FLASH_AREA_IMG_1_PRIMARY_DEV_ID="$(FLASH_AREA_IMG_1_PRIMARY_DEV_ID)"\
FLASH_AREA_IMG_1_PRIMARY_START=$(FLASH_AREA_IMG_1_PRIMARY_START) \
FLASH_AREA_IMG_1_PRIMARY_SIZE=$(FLASH_AREA_IMG_1_PRIMARY_SIZE) \
FLASH_AREA_IMG_1_SECONDARY_DEV_ID="$(FLASH_AREA_IMG_1_SECONDARY_DEV_ID)"\
FLASH_AREA_IMG_1_SECONDARY_START=$(FLASH_AREA_IMG_1_SECONDARY_START) \
FLASH_AREA_IMG_1_SECONDARY_SIZE=$(FLASH_AREA_IMG_1_SECONDARY_SIZE)
ifneq ($(FLASH_AREA_IMAGE_SWAP_STATUS_DEV_ID),)
DEFINES+=\
FLASH_AREA_IMAGE_SWAP_STATUS_DEV_ID="$(FLASH_AREA_IMAGE_SWAP_STATUS_DEV_ID)"\
FLASH_AREA_IMAGE_SWAP_STATUS_START=$(FLASH_AREA_IMAGE_SWAP_STATUS_START)\
FLASH_AREA_IMAGE_SWAP_STATUS_SIZE=$(FLASH_AREA_IMAGE_SWAP_STATUS_SIZE)
endif
ifneq ($(FLASH_AREA_IMAGE_SCRATCH_DEV_ID),)
DEFINES+=\
FLASH_AREA_IMAGE_SCRATCH_DEV_ID="$(FLASH_AREA_IMAGE_SCRATCH_DEV_ID)"\
FLASH_AREA_IMAGE_SCRATCH_START=$(FLASH_AREA_IMAGE_SCRATCH_START)\
FLASH_AREA_IMAGE_SCRATCH_SIZE=$(FLASH_AREA_IMAGE_SCRATCH_SIZE)
endif
ifeq ($(USE_EXTERNAL_FLASH),1)
DEFINES+=OTA_USE_EXTERNAL_FLASH=1
endif
ifeq ($(CY_RUN_CODE_FROM_XIP),1)
DEFINES+=CY_RUN_CODE_FROM_XIP=1
endif
ifeq ($(CY_XIP_SMIF_MODE_CHANGE),1)
DEFINES+=CY_XIP_SMIF_MODE_CHANGE=1
endif
##################################
# Additional / custom linker flags.
##################################
# This section needs to be before finding LINKER_SCRIPT_WILDCARD as we need the extension defined
ifeq ($(TOOLCHAIN),GCC_ARM)
CY_ELF_TO_HEX=$(MTB_TOOLCHAIN_GCC_ARM__OBJCOPY)
CY_ELF_TO_HEX_OPTIONS="-O ihex"
CY_ELF_TO_HEX_FILE_ORDER="elf_first"
CY_TOOLCHAIN=GCC
CY_TOOLCHAIN_LS_EXT=ld
LDFLAGS+="-Wl,--defsym,MCUBOOT_HEADER_SIZE=$(MCUBOOT_HEADER_SIZE),--defsym,FLASH_AREA_IMG_1_PRIMARY_START=$(FLASH_AREA_IMG_1_PRIMARY_START),--defsym,FLASH_AREA_IMG_1_PRIMARY_SIZE=$(FLASH_AREA_IMG_1_PRIMARY_SIZE)"
else
ifeq ($(TOOLCHAIN),IAR)
CY_ELF_TO_HEX="$(CY_COMPILER_IAR_DIR)/bin/ielftool"
CY_ELF_TO_HEX_OPTIONS="--ihex"
CY_ELF_TO_HEX_FILE_ORDER="elf_first"
CY_TOOLCHAIN=$(TOOLCHAIN)
CY_TOOLCHAIN_LS_EXT=icf
LDFLAGS+=--config_def MCUBOOT_HEADER_SIZE=$(MCUBOOT_HEADER_SIZE) --config_def FLASH_AREA_IMG_1_PRIMARY_START=$(FLASH_AREA_IMG_1_PRIMARY_START) --config_def FLASH_AREA_IMG_1_PRIMARY_SIZE=$(FLASH_AREA_IMG_1_PRIMARY_SIZE)
else
ifeq ($(TOOLCHAIN),ARM)
CY_ELF_TO_HEX=$(MTB_TOOLCHAIN_ARM__BASE_DIR)/bin/fromelf
CY_ELF_TO_HEX_OPTIONS="--i32combined --output"
CY_ELF_TO_HEX_FILE_ORDER="hex_first"
CY_TOOLCHAIN=GCC
CY_TOOLCHAIN_LS_EXT=sct
LDFLAGS+=--pd=-DMCUBOOT_HEADER_SIZE=$(MCUBOOT_HEADER_SIZE) --pd=-DFLASH_AREA_IMG_1_PRIMARY_START=$(FLASH_AREA_IMG_1_PRIMARY_START) --pd=-DFLASH_AREA_IMG_1_PRIMARY_SIZE=$(FLASH_AREA_IMG_1_PRIMARY_SIZE)
else
$(error Must define toolchain ! GCC_ARM, ARM, or IAR)
endif #ARM
endif #IAR
endif #GCC_ARM
# Find Linker Script using wildcard
# Directory within ota-upgrade library
OTA_LINKER_SCRIPT_BASE_DIR=$(SEARCH_ota-update)/platforms/$(OTA_PLATFORM)/linker_scripts/COMPONENT_$(CORE)/TOOLCHAIN_$(TOOLCHAIN)/ota
ifneq ($(findstring $(OTA_PLATFORM),PSOC_062_1M PSOC_063_1M),)
OTA_LINKER_SCRIPT_TYPE=_ota_cm0p_int
else
ifeq ($(CY_RUN_CODE_FROM_XIP),1)
OTA_LINKER_SCRIPT_TYPE=_ota_xip
else
OTA_LINKER_SCRIPT_TYPE=_ota_int
endif
endif
LINKER_SCRIPT_WILDCARD=$(OTA_LINKER_SCRIPT_BASE_DIR)/*$(OTA_LINKER_SCRIPT_TYPE).$(CY_TOOLCHAIN_LS_EXT)
LINKER_SCRIPT=$(wildcard $(LINKER_SCRIPT_WILDCARD))
###################################################################################################
# OTA POST BUILD scripting
###################################################################################################
######################################
# Build Location / Output directory
######################################
# output directory for use in the sign_script.bash
OUTPUT_FILE_PATH:=$(CY_BUILD_LOC)/$(TARGET)/$(CONFIG)
CY_HEX_TO_BIN="$(MTB_TOOLCHAIN_GCC_ARM__OBJCOPY)"
APP_BUILD_VERSION=$(OTA_APP_VERSION_MAJOR).$(OTA_APP_VERSION_MINOR).$(OTA_APP_VERSION_BUILD)
# MCUBoot flash support location
MCUBOOT_DIR=$(SEARCH_ota-update)/source/port_support/mcuboot
IMGTOOL_SCRIPT_NAME=imgtool/imgtool.py
MCUBOOT_SCRIPT_FILE_DIR=$(MCUBOOT_DIR)
#Path for keys used for signing, to use your keys replace the keys in the directory
#You can also provide path to the directory where you have the keys.
MCUBOOT_KEY_DIR=./ota_source/keys
#Name of the file containing the private key used for image signing
MCUBOOT_KEY_FILE=cypress-test-ec-p256.pem
SIGN_SCRIPT_FILE_PATH=$(SEARCH_ota-update)/scripts/sign_script.bash
# Signing is enabled by default
# To disable signing, Use "create" for PSoC 062 instead of "sign", and no key path (use a space " " for keypath to keep batch happy)
# MCUBoot must also be modified to skip checking the signature, see README for more details.
# For signing, use "sign" and key path:
IMGTOOL_COMMAND_ARG=sign
CY_SIGNING_KEY_ARG="-k $(MCUBOOT_KEY_DIR)/$(MCUBOOT_KEY_FILE)"
# IMGTOOL_COMMAND_ARG=create
# CY_SIGNING_KEY_ARG=" "
POSTBUILD=$(SIGN_SCRIPT_FILE_PATH) $(OUTPUT_FILE_PATH) $(APPNAME) $(CY_PYTHON_PATH)\
$(CY_ELF_TO_HEX) $(CY_ELF_TO_HEX_OPTIONS) $(CY_ELF_TO_HEX_FILE_ORDER)\
$(MCUBOOT_SCRIPT_FILE_DIR) $(IMGTOOL_SCRIPT_NAME) $(IMGTOOL_COMMAND_ARG) $(FLASH_ERASE_SECONDARY_SLOT_VALUE) $(MCUBOOT_HEADER_SIZE)\
$(MCUBOOT_MAX_IMG_SECTORS) $(APP_BUILD_VERSION) $(FLASH_AREA_IMG_1_PRIMARY_START) $(FLASH_AREA_IMG_1_PRIMARY_SIZE)\
$(CY_HEX_TO_BIN) $(CY_SIGNING_KEY_ARG)
else #OTA_SUPPORT
# Ignore the OTA code
CY_IGNORE+=./ota_source
# This library is only needed for OTA, therefore excluded from the build
CY_IGNORE+=$(SEARCH_ota-update)
endif # OTA_SUPPORT
################################################################################
# Paths
################################################################################
# Relative path to the project directory (default is the Makefile's directory).
#
# This controls where automatic source code discovery looks for code.
CY_APP_PATH=
# Relative path to the shared repo location.
#
# All .mtb files have the format, <URI>#<COMMIT>#<LOCATION>. If the <LOCATION> field
# begins with $$ASSET_REPO$$, then the repo is deposited in the path specified by
# the CY_GETLIBS_SHARED_PATH variable. The default location is one directory level
# above the current app directory.
# This is used with CY_GETLIBS_SHARED_NAME variable, which specifies the directory name.
CY_GETLIBS_SHARED_PATH=../
# Directory name of the shared repo location.
#
CY_GETLIBS_SHARED_NAME=mtb_shared
# Absolute path to the compiler's "bin" directory.
#
# The default depends on the selected TOOLCHAIN (GCC_ARM uses the ModusToolbox
# software provided compiler by default).
CY_COMPILER_PATH=
# Locate ModusToolbox helper tools folders in default installation
# locations for Windows, Linux, and macOS.
CY_WIN_HOME=$(subst \,/,$(USERPROFILE))
CY_TOOLS_PATHS ?= $(wildcard \
$(CY_WIN_HOME)/ModusToolbox/tools_* \
$(HOME)/ModusToolbox/tools_* \
/Applications/ModusToolbox/tools_*)
# If you install ModusToolbox software in a custom location, add the path to its
# "tools_X.Y" folder (where X and Y are the version number of the tools
# folder). Make sure you use forward slashes.
CY_TOOLS_PATHS+=
# Default to the newest installed tools folder, or the users override (if it's
# found).
CY_TOOLS_DIR=$(lastword $(sort $(wildcard $(CY_TOOLS_PATHS))))
ifeq ($(CY_TOOLS_DIR),)
$(error Unable to find any of the available CY_TOOLS_PATHS -- $(CY_TOOLS_PATHS). On Windows, use forward slashes.)
endif
$(info Tools Directory: $(CY_TOOLS_DIR))
include $(CY_TOOLS_DIR)/make/start.mk
###############################################################################
#
# OTA flashmap parser must be run after start.mk so that libs/mtb.mk is valid
#
###############################################################################
ifeq ($(OTA_SUPPORT),1)
#
# Only when we are in the correct build pass
#
ifneq ($(MAKECMDGOALS),getlibs)
ifneq ($(MAKECMDGOALS),get_app_info)
ifneq ($(MAKECMDGOALS),printlibs)
ifneq ($(FLASHMAP_PYTHON_SCRIPT),)
$(info "flashmap.py $(CY_PYTHON_PATH) $(SEARCH_ota-update)/scripts/$(FLASHMAP_PYTHON_SCRIPT) -p $(FLASHMAP_PLATFORM) -i $(OTA_FLASH_MAP) > flashmap.mk")
$(shell $(CY_PYTHON_PATH) $(SEARCH_ota-update)/scripts/$(FLASHMAP_PYTHON_SCRIPT) -p $(FLASHMAP_PLATFORM) -i $(OTA_FLASH_MAP) > flashmap.mk)
flash_map_status=$(shell if [ -s "flashmap.mk" ]; then echo "success"; fi )
ifeq ($(flash_map_status),)
$(info "")
$(error Failed to create flashmap.mk !)
$(info "")
else
$(info include flashmap.mk)
include ./flashmap.mk
endif # flash_map_status
endif # FLASHMAP_PYTHON_SCRIPT
endif # NOT getlibs
endif # NOT get_app_info
endif # NOT printlibs
endif # OTA_SUPPORT