This guide shows Makefile variables and build DEFINES used when building an application with ota-bootloader-abstraction library along with ota-update library support.
| Makefile Variable | Example | Description |
|---|---|---|
| TARGET?=<target_name> | TARGET?=CY8CPROTO-062-4343W | Target Kit for build |
| CORE?=<core_type> | CORE?=CM4 | Core CPU for Application (CM33, CM4) |
| APPNAME?=<application_name> | APPNAME=ota-test | Name of Application |
| TOOLCHAIN?=<toolchain> | TOOLCHAIN?=GCC_ARM | GCC_ARM (default) ARM IAR |
| CONFIG?=<build_level> | CONFIG?=Debug | Build level - Debug - Release |
| Makefile addition | Required | Default if not defined | Description |
|---|---|---|---|
| CY_BUILD_LOCATION=<Application's Build Working Directory path> | Yes | Error | Required by flashmap.py for setting output directory for use in sign_script.bash script. |
| APP_VERSION_MAJOR=<application_version> | Yes | Error | Application Major version number X.y.z |
| APP_VERSION_MINOR=<application_version> | Yes | Error | Application Minor version number x.Y.z |
| APP_VERSION_BUILD=<application_version> | Yes | Error | Application Build version number x.y.Z |
| OTA_PLATFORM=<platform_type> | No | Depends on Target Support | <platform_type> must be one of: XMC7200 - ex: KIT_XMC72_EVK and KIT_XMC72_EVK_MUR_43439M2 XMC7100 - ex: KIT_XMC71_EVK_LITE_V1 CYW20829 - ex: CYW920829-KEYBOARD and CYW920829-MOUSE CYW89829 - ex: CYW989829M2EVB-01 PSOC_062_512K - ex: CY8CPROTO-062S3-4343W PSOC_062_1M - ex: CY8CKIT-062-BLE PSOC_062_2M - ex: CY8CPROTO-062-4343W CY8CEVAL-062S2-LAI-4373M2 CY8CEVAL-062S2-CYW943439M2IPA1 CY8CEVAL-062S2-CYW955513SDM2WLIPA CY8CKIT-062S2-43012 PSOC_063_1M - ex: CY8CPROTO-063-BLE PSOC_064_2M - ex: CY8CKIT-064B0S2-4343W Default value is set for officially supported kits. For reference kit value should be set. |
| OTA_FLASH_MAP=<flash_map.json> | No | Depends on Target Support | Default flash_maps are available here for supported targets. If this makefile entry is empty then ota-bootloader-abstraction library uses target default flash map for generating flashmap.mk. JSON file passed to flashmap.py that generates flashmap.mk. For XMC7200, new flashmap format is used and it is parsed using flashmap_xmc.py. The JSON file defines: - Internal / external flash usage - Flash area location and sizes - Number of images / slots - XIP (from external flash) if defined |
| OTA_LINKER_FILE=<ota_linker_file> | Yes | Error | Based on selected target, Create OTA linker file for XIP or Non XIP mode. Template linkers for supported platforms are available here. |
| CY_TEST_APP_VERSION_IN_TAR=<0,1> | No | 0 | Set to 1 to enable checking application version in TAR file in OTA library when updating using a TAR file. |
| CY_PYTHON_PATH=<Python installed path> | Yes | Error | MCUBootloader based OTA Pre-build and Post-build scripts uses python. Users is expected to use this Makefile entry to provide Python path. |
| IMG_SIGNING_SCRIPT_TOOL_PATH=<Image Signing Tool Path> | No | For PSoC6 - Image Signing Tool provided by MCUBootloader. For 20829 - cysecuretools v4.2 or greater For 89829 - cysecuretools v5.1 or greater For XMC7200 - cysecuretools 5.0 |
Users can use this Makefile entry to use a tool of their choice for signing update images. If this makefile entry is empty, ota-bootloader-abstraction library uses the default Image signing tools depending on the Target device. |
| CY_DEVICE_LCS=<NORMAL_NO_SECURE or SECURE> | No | NORMAL_NO_SECURE | Device Mode by default set to NORMAL_NO_SECURE. |
| CY_SIGN_KEY_PATH=<Image Signing Key Path> | No | Test key 'cypress-test-ec-p256.pem' is used for signing. | MCUBootloader uses the default key for validating images. Users can use this Makefile entry to use their own key for signing BOOT/UPGRADE images. |
| CY_ENC_IMG=<0,1> | No | 0 | When using the default POSTBUILD scripts of the ota-bootloader-abstraction library, setting it to 1 will generate encrypted OTA BOOT and OTA UPGRADE image. |
| CY_SMIF_ENC=<0,1> | No | 0 | Setting it to 1 will generate SMIF encrypted OTA BOOT image and OTA UPGRADE image. This option is valid only when CY_DEVICE_LCS=SECURE and CY_ENC_IMG=1. |
| CY_ENC_KEY=<Encryption key file> | No | Test encryption key 'enc-ec256-pub.pem' is used for image encryption. | In case of CY_SMIF_ENC=1, user need to provide the encryption key which is provisioned to the device. |
| CY_NONCE=<Nounce file> | No | 0 | This is mandatory only when CY_SMIF_ENC is set to 1. |
| CY_OEM_PRIVATE_KEY=<OEM private key file> | No | Test OEM private key 'priv_oem_0.pem' is used for image signing. | To authenticate/sign OTA images using OEM private keys. In case of CY_DEVICE_LCS=SECURE, user need to provide the OEM keys which is provisioned to the device. |
| OTA_APP_POLICY_PATH=<Application's Policy File Path> | No | Depends on Target Support | User needs to define this Makefile entry to provide the policy file path for 20829 and 89829 devices which use cysecuretools for signing update images. Refer to MCUBoot App Readme. This is not required for PSoC6 non-secure devices. |
| OTA_APP_POSTBUILD=<Application's POSTBUILD commands> | No | Post-build commands for generating Signed BOOT and UPGRADE images. | Users can use this Makefile entry to provide their own post-build commands. If this makefile entry is empty, the ota-bootloader-abstraction library uses the default POSTBUILD commands which create signed BOOT and UPGRADE images. |
When the 20829 based OTA Application utilizes the default postbuild scripts from the ota-bootloader-abstraction library, the BOOT and UPGRADE images are generated at the specified build location(CY_BUILD_LOCATION).
| Platform | Device Mode | Encryption | BOOT | UPGRADE | Remarks |
|---|---|---|---|---|---|
| CYW20829 | NORMAL_NO_SECURE | CY_ENC_IMG=0 | <APPNAME>.signed.bin | <APPNAME>.update.signed.bin | |
| CYW20829 | NORMAL_NO_SECURE | CY_ENC_IMG=1 | <APPNAME>.signed.bin | <APPNAME>.update.signed.bin | |
| CYW20829 | SECURE | CY_ENC_IMG=1 | <APPNAME>.signed.bin | <APPNAME>.upgrade_signed.bin | |
| CYW20829 | SECURE | CY_ENC_IMG=1 CY_SMIF_ENC=1 |
<APPNAME>.encrypted.bin | <APPNAME>.upgrade_signed.bin <APPNAME>.upgrade_encrypted.bin |
In case of on-the-fly encryption <APPNAME>.upgrade_signed.bin should be used as upgrade image |
Notes:
- ota-bootloader-abstraction repo provides makefiles/mcuboot/mcuboot_support.mk file for simplifying the ota-bootloader-abstraction library integration with the applications.
- Application Makefile needs to include mcuboot_support.mk file from the ota-bootloader-abstraction library for the Target dependent Flashmap Configurations and pre/post build scripts.
include ../mtb_shared/ota-bootloader-abstraction/<version>/makefiles/mcuboot/mcuboot_support.mk