doc: Fixed consistency of MCUboot

# [mcuboot](http://mcuboot.com/)

# [MCUboot](http://mcuboot.com/)

[![Package on PyPI](https://img.shields.io/pypi/v/imgtool.svg)][pypi]

[![Coverity Scan Build Status](https://scan.coverity.com/projects/12307/badge.svg)][coverity]

[travis]: https://travis-ci.org/mcu-tools/mcuboot

[license]: https://github.com/mcu-tools/mcuboot/blob/main/LICENSE

This is mcuboot version 1.8.0

This is MCUboot version 1.8.0

MCUboot is a secure bootloader for 32-bit MCUs. The goal of MCUboot is to

define a common infrastructure for the bootloader, system flash layout on

simple software upgrades.

MCUboot is operating system and hardware independent and relies on

hardware porting layers from the operating. Currently, mcuboot works

hardware porting layers from the operating. Currently, MCUboot works

with both the Apache Mynewt and Zephyr operating systems, but more

ports are planned in the future. RIOT is currently supported as a boot

target with a complete port planned.

The issues being planned and worked on are tracked using GitHub issues. To

participate please visit:

[MCUBoot GitHub Issues](https://github.com/mcu-tools/mcuboot/issues)

[MCUboot GitHub Issues](https://github.com/mcu-tools/mcuboot/issues)

~~Issues were previously tracked on [MCUboot JIRA](https://runtimeco.atlassian.net/projects/MCUB/summary)

, but it is now deprecated.~~

Information and documentation on the bootloader are stored within the source.

~~It was previously also documented on confluence:

[MCUBoot Confluence](https://runtimeco.atlassian.net/wiki/discover/all-updates)

[MCUboot Confluence](https://runtimeco.atlassian.net/wiki/discover/all-updates)

however, it is now deprecated and not currently maintained~~

For more information in the source, here are some pointers:

- [boot/mynewt](boot/mynewt): Mynewt bootloader app

- [boot/nuttx](boot/nuttx): Bootloader application and port of MCUboot interfaces for NuttX.

- [boot/espressif](boot/espressif): Bootloader application and MCUboot port for Espressif SoCs.

- [imgtool](scripts/imgtool.py): A tool to securely sign firmware images for booting by mcuboot.

- [imgtool](scripts/imgtool.py): A tool to securely sign firmware images for booting by MCUboot.

- [sim](sim): A bootloader simulator for testing and regression

## Joining

### Blinking LED test application for MCUBoot Bootloader

### Blinking LED test application for MCUboot Bootloader

### Description

Implements simple Blinky LED CM4 application to demonstrate MCUBoot Application operation in terms of BOOT and UPGRADE process.

Implements simple Blinky LED CM4 application to demonstrate MCUboot Application operation in terms of BOOT and UPGRADE process.

It is started by MCUBoot Application which is running on CM0p.

It is started by MCUboot Application which is running on CM0p.

Functionality:

### Hardware limitations

Since this application is created to demonstrate MCUBoot library features and not as reference examples some considerations are taken.

Since this application is created to demonstrate MCUboot library features and not as reference examples some considerations are taken.

1. Port/pin `P5_0` and `P5_1` used to configure serial port for debug prints. These pins are the most commonly used for serial port connection among available Cypress PSoC 6 kits. If you try to use custom hardware with this application - change definitions of `CY_DEBUG_UART_TX` and `CY_DEBUG_UART_RX` in `main.c` of BlinkyApp to port/pin pairs corresponding to your design.

2. Port `GPIO_PRT13` pin `7U` used to define user connection LED. This pin is the most commonly used for USER_LED connection among available Cypress PSoC 6 kits. If you try to use custom hardware with this application - change definitions of `LED_PORT` and `LED_PIN` in `main.c` of BlinkyApp to port/pin pairs corresponding to your design.

### Post-Build

Post build action is executed at compile time for `BlinkyApp`. In case of build for `PSOC_062_2M` platform it calls `imgtool` from `MCUBoot` scripts and adds signature to compiled image.

Post build action is executed at compile time for `BlinkyApp`. In case of build for `PSOC_062_2M` platform it calls `imgtool` from `MCUboot` scripts and adds signature to compiled image.

Flags passed to `imgtool` for signature are defined in `SIGN_ARGS` variable in BlinkyApp.mk.

**Flags:**

- `BUILDCFG` - configuration **Release** or **Debug**

- `MAKEINFO` - 0 (default) - less build info, 1 - verbose output of compilation.

- `HEADER_OFFSET` - 0 (default) - no offset of output hex file, 0x%VALUE% - offset for output hex file. Value 0x10000 is slot size MCUBoot Bootloader in this example.

- `IMG_TYPE` - `BOOT` (default) - build image for BOOT slot of MCUBoot Bootloader, `UPGRADE` - build image for UPGRADE slot of MCUBoot Bootloader.

- `HEADER_OFFSET` - 0 (default) - no offset of output hex file, 0x%VALUE% - offset for output hex file. Value 0x10000 is slot size MCUboot Bootloader in this example.

- `IMG_TYPE` - `BOOT` (default) - build image for BOOT slot of MCUboot Bootloader, `UPGRADE` - build image for UPGRADE slot of MCUboot Bootloader.

- `ENC_IMG` - 0 (default) - build regular upgrade image, `1` - build encrypted upgrade image (MCUBootApp should also be built with this flash set 1)

**NOTE**: In case of `UPGRADE` image `HEADER_OFFSET` should be set to MCUBoot Bootloader slot size.

**NOTE**: In case of `UPGRADE` image `HEADER_OFFSET` should be set to MCUboot Bootloader slot size.

### Example terminal output

### Port of MCUBoot library to be used with Cypress targets

### Port of MCUboot library to be used with Cypress targets

**Solution Description**

Given solution demonstrates operation of MCUBoot on Cypress' PSoC6 device.

Given solution demonstrates operation of MCUboot on Cypress' PSoC6 device.

There are two applications implemented:

* MCUBootApp - PSoC6 MCUBoot-based bootloading application;

* MCUBootApp - PSoC6 MCUboot-based bootloading application;

* BlinkyApp - simple PSoC6 blinking LED application which is a target of BOOT/UPGRADE;

Cypress boards, that can be used with this evaluation example:

Default value of `MCUBOOT_IMAGE_NUMBER` is 1, which corresponds to single image configuratios.

In multi-image operation (two images are considered for simplicity) MCUBoot Bootloader application operates as following:

In multi-image operation (two images are considered for simplicity) MCUboot Bootloader application operates as following:

* Verifies Primary_1 and Primary_2 images;

* Verifies Secondary_1 and Secondary_2 images;

**Default Flash map for Multi-Image operation:**

`0x10000000 - 0x10018000` - MCUBoot Bootloader

`0x10000000 - 0x10018000` - MCUboot Bootloader

`0x10018000 - 0x10028000` - Primary_1 (BOOT) slot of Bootloader

### Hardware limitations

Since this application is created to demonstrate MCUBoot library features and not as reference examples some considerations are taken.

Since this application is created to demonstrate MCUboot library features and not as reference examples some considerations are taken.

1. `SCB5` used to configure serial port for debug prints. This is the most commonly used Serial Communication Block number among available Cypress PSoC 6 kits. If you try to use custom hardware with this application - change definition of `CYBSP_UART_HW` in `main.c` of MCUBootApp to SCB* that correspond to your design.

### Disclaimer

Given solution is included in `mcuboot` repository with purpose to demonstrate basic consepts and features of MCUBoot library on Cypress PSoC 6 device. Applications are created per mcuboot library maintainers requirements. Implemetation differs from conventional and recomended by Cypress Semiconductors development flow for PSoC 6 devices. These applications are not recomended as a starting point for development and should not be considered as supported examples for PSoC 6 devices.

Given solution is included in `MCUboot` repository with purpose to demonstrate basic consepts and features of MCUboot library on Cypress PSoC 6 device. Applications are created per MCUboot library maintainers requirements. Implemetation differs from conventional and recomended by Cypress Semiconductors development flow for PSoC 6 devices. These applications are not recomended as a starting point for development and should not be considered as supported examples for PSoC 6 devices.

Examples provided to use with **ModusToolbox® Software Environment** are a recommended reference point to start development of MCUBoot based bootloaders for PSoC 6 devices.

Examples provided to use with **ModusToolbox® Software Environment** are a recommended reference point to start development of MCUboot based bootloaders for PSoC 6 devices.

Refer to **Cypress Semiconductors** [github](https://github.com/cypresssemiconductorco) page to find examples.

### Solution Description

There are two applications implemented:

* MCUBootApp - PSoC6 MCUBoot-based bootloading application;

* MCUBootApp - PSoC6 MCUboot-based bootloading application;

* BlinkyApp - simple PSoC6 blinking LED application which is a target of BOOT/UPGRADE;

The default flash map for MCUBootApp implemented is next:

Root directory for build is **boot/cypress.**

This folder contains make files infrastructure for building both MCUBoot Bootloader and sample BlinkyApp application used for Bootloader demo functionality.

This folder contains make files infrastructure for building both MCUboot Bootloader and sample BlinkyApp application used for Bootloader demo functionality.

Instructions on how to build and upload MCUBootApp bootloader application and sample user applocation are located in `Readme.md` files in corresponding folders.

Supported platforms for `MCUBoot`, `BlinkyApp`:

Supported platforms for `MCUboot`, `BlinkyApp`:

* PSOC_062_2M

* PSOC_062_1M

# mcuboot - apps/boot

# MCUboot - apps/boot

This sample app implements a boot loader for the Mynewt OS (apache.mynewt.org).

This app requires the following Mynewt repositories: