mcuboot/README.md

# [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]
[![Build Status (Sim)](https://github.com/mcu-tools/mcuboot/workflows/Sim/badge.svg)][sim]
[![Build Status (Mynewt)](https://github.com/mcu-tools/mcuboot/workflows/Mynewt/badge.svg)][mynewt]
[![Publishing Status (imgtool)](https://github.com/mcu-tools/mcuboot/workflows/imgtool/badge.svg)][imgtool]
[![Build Status (Travis CI)](https://img.shields.io/travis/mcu-tools/mcuboot/main.svg?label=travis-ci)][travis]
[![Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)][license]

[pypi]: https://pypi.org/project/imgtool/
[coverity]: https://scan.coverity.com/projects/mcuboot
[sim]: https://github.com/mcu-tools/mcuboot/actions?query=workflow:Sim
[mynewt]: https://github.com/mcu-tools/mcuboot/actions?query=workflow:Mynewt
[imgtool]: https://github.com/mcu-tools/mcuboot/actions?query=workflow:imgtool
[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

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
microcontroller systems, and to provide a secure bootloader that enables
simple software upgrades.

MCUboot is operating system and hardware independent and relies on
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.

## Using MCUboot

Instructions for different operating systems can be found here:
- [Zephyr](docs/readme-zephyr.md)
- [Mynewt](docs/readme-mynewt.md)
- [RIOT](docs/readme-riot.md)
- [Mbed-OS](docs/readme-mbed.md)
- [NuttX](docs/readme-nuttx.md)
- [Espressif IDF](docs/readme-espressif.md)
- [Simulator](sim/README.rst)

## Roadmap

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)

~~Issues were previously tracked on [MCUboot JIRA](https://runtimeco.atlassian.net/projects/MCUB/summary)
, but it is now deprecated.~~

## Browsing

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)
however, it is now deprecated and not currently maintained~~

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

- [boot/bootutil](boot/bootutil): The core of the bootloader itself.
- [boot/boot\_serial](boot/boot_serial): Support for serial upgrade within the bootloader itself.
- [boot/zephyr](boot/zephyr): Port of the bootloader to Zephyr
- [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.
- [sim](sim): A bootloader simulator for testing and regression

## Joining

Developers welcome!

* [Our developer mailing list](https://groups.io/g/MCUBoot)
* [Our Slack channel](https://mcuboot.slack.com/) <br />
  Get [your invite](https://join.slack.com/t/mcuboot/shared_invite/MjE2NDcwMTQ2MTYyLTE1MDA4MTIzNTAtYzgyZTU0NjFkMg)
Add badges, link url - Add coverity and travis-ci badges - Link title to project url - Remove version information from header text Signed-off-by: Fabio Utzig <utzig@apache.org> 2017-08-11 01:55:27 +08:00			`# [mcuboot](http://mcuboot.com/)`
update README 2017-02-08 05:12:19 +08:00
ci: update workflows names and add more badges Fix workflows names on yaml root to be able to use them to refer to the workflow. Add badges for pypi, workflows and license. Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no> 2020-11-12 21:45:07 +08:00			`[![Package on PyPI](https://img.shields.io/pypi/v/imgtool.svg)][pypi]`
Add badges, link url - Add coverity and travis-ci badges - Link title to project url - Remove version information from header text Signed-off-by: Fabio Utzig <utzig@apache.org> 2017-08-11 01:55:27 +08:00			`[![Coverity Scan Build Status](https://scan.coverity.com/projects/12307/badge.svg)][coverity]`
ci: update workflows names and add more badges Fix workflows names on yaml root to be able to use them to refer to the workflow. Add badges for pypi, workflows and license. Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no> 2020-11-12 21:45:07 +08:00			`[![Build Status (Sim)](https://github.com/mcu-tools/mcuboot/workflows/Sim/badge.svg)][sim]`
			`[![Build Status (Mynewt)](https://github.com/mcu-tools/mcuboot/workflows/Mynewt/badge.svg)][mynewt]`
			`[![Publishing Status (imgtool)](https://github.com/mcu-tools/mcuboot/workflows/imgtool/badge.svg)][imgtool]`
Migrate master->main Change references in CI and docs from 'master' to 'main' as the primary branch has been renamed. Signed-off-by: David Brown <david.brown@linaro.org> 2021-05-15 00:12:10 +08:00			`[![Build Status (Travis CI)](https://img.shields.io/travis/mcu-tools/mcuboot/main.svg?label=travis-ci)][travis]`
ci: update workflows names and add more badges Fix workflows names on yaml root to be able to use them to refer to the workflow. Add badges for pypi, workflows and license. Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no> 2020-11-12 21:45:07 +08:00			`[![Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)][license]`
Add badges, link url - Add coverity and travis-ci badges - Link title to project url - Remove version information from header text Signed-off-by: Fabio Utzig <utzig@apache.org> 2017-08-11 01:55:27 +08:00
ci: update workflows names and add more badges Fix workflows names on yaml root to be able to use them to refer to the workflow. Add badges for pypi, workflows and license. Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no> 2020-11-12 21:45:07 +08:00			`[pypi]: https://pypi.org/project/imgtool/`
Add badges, link url - Add coverity and travis-ci badges - Link title to project url - Remove version information from header text Signed-off-by: Fabio Utzig <utzig@apache.org> 2017-08-11 01:55:27 +08:00			`[coverity]: https://scan.coverity.com/projects/mcuboot`
ci: use names to refer to workflows in badges Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no> 2020-11-13 00:17:46 +08:00			`[sim]: https://github.com/mcu-tools/mcuboot/actions?query=workflow:Sim`
			`[mynewt]: https://github.com/mcu-tools/mcuboot/actions?query=workflow:Mynewt`
			`[imgtool]: https://github.com/mcu-tools/mcuboot/actions?query=workflow:imgtool`
doc: fix github urls to use the new org Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no> 2020-11-10 23:35:04 +08:00			`[travis]: https://travis-ci.org/mcu-tools/mcuboot`
Migrate master->main Change references in CI and docs from 'master' to 'main' as the primary branch has been renamed. Signed-off-by: David Brown <david.brown@linaro.org> 2021-05-15 00:12:10 +08:00			`[license]: https://github.com/mcu-tools/mcuboot/blob/main/LICENSE`
Bump version to 0.9.0-rc2 Version is stored in repository.yaml for mynewt. Otherwise, put a single mention of it in the README.md. Signed-off-by: David Brown <david.brown@linaro.org> 2017-07-27 09:02:33 +08:00
Preps for 1.8.0 Update version fields for 1.8.0 release. Signed-off-by: David Brown <david.brown@linaro.org> 2021-10-12 23:52:18 +08:00			`This is mcuboot version 1.8.0`
update README 2017-02-08 05:12:19 +08:00
README.md: Minor typographical and grammar fixes These are some minor fixes to the README.md files submitted by Aidan Earle <a_earle@live.com>. Signed-off-by: David Brown <david.brown@linaro.org> 2019-12-03 03:02:59 +08:00			`MCUboot is a secure bootloader for 32-bit MCUs. The goal of MCUboot is to`
Add badges, link url - Add coverity and travis-ci badges - Link title to project url - Remove version information from header text Signed-off-by: Fabio Utzig <utzig@apache.org> 2017-08-11 01:55:27 +08:00			`define a common infrastructure for the bootloader, system flash layout on`
			`microcontroller systems, and to provide a secure bootloader that enables`
README.md: Minor typographical and grammar fixes These are some minor fixes to the README.md files submitted by Aidan Earle <a_earle@live.com>. Signed-off-by: David Brown <david.brown@linaro.org> 2019-12-03 03:02:59 +08:00			`simple software upgrades.`
update README 2017-02-08 05:12:19 +08:00
Add deprecated warning to Jira and Confluence links This will fix #336 by adding deprecation warning to Jira and Confluence links as these are not used by the project anymore. Signed-off-by: Sigvart M. Hovland <sigvart.m@gmail.com> 2018-09-30 00:58:55 +08:00			`MCUboot is operating system and hardware independent and relies on`
README.md: Minor typographical and grammar fixes These are some minor fixes to the README.md files submitted by Aidan Earle <a_earle@live.com>. Signed-off-by: David Brown <david.brown@linaro.org> 2019-12-03 03:02:59 +08:00			`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`
Fix sentence wording per review Signed-off-by: Fabio Utzig <utzig@apache.org> 2017-07-21 00:38:22 +08:00			`target with a complete port planned.`
update README 2017-02-08 05:12:19 +08:00
docs: Link to instructions from landing pages Link to usage instructions from the main README file and from docs/index.md so that the usage is visible from the root documentation files. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no> 2018-01-23 22:43:46 +08:00			`## Using MCUboot`

			`Instructions for different operating systems can be found here:`
			`- [Zephyr](docs/readme-zephyr.md)`
			`- [Mynewt](docs/readme-mynewt.md)`
			`- [RIOT](docs/readme-riot.md)`
Update main README with links to Mbed-OS documentation Signed-off-by: George Beckstein <becksteing@embeddedplanet.com> 2020-11-05 13:51:09 +08:00			`- [Mbed-OS](docs/readme-mbed.md)`
README.md: Add references to the NuttX port Signed-off-by: Gustavo Henrique Nihei <gustavo.nihei@espressif.com> 2021-08-07 03:15:33 +08:00			`- [NuttX](docs/readme-nuttx.md)`
readme.md: Add references to the Espressif IDF port. Signed-off-by: Almir Okato <almir.okato@espressif.com> 2021-08-24 01:12:16 +08:00			`- [Espressif IDF](docs/readme-espressif.md)`
Add a link to the simulator from the top-level README Hopefully this will help a little with awareness of the existence of the simulator. Signed-off-by: David Brown <david.brown@linaro.org> 2020-05-12 04:10:00 +08:00			`- [Simulator](sim/README.rst)`
docs: Link to instructions from landing pages Link to usage instructions from the main README file and from docs/index.md so that the usage is visible from the root documentation files. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no> 2018-01-23 22:43:46 +08:00
update README 2017-02-08 05:12:19 +08:00			`## Roadmap`

Add deprecated warning to Jira and Confluence links This will fix #336 by adding deprecation warning to Jira and Confluence links as these are not used by the project anymore. Signed-off-by: Sigvart M. Hovland <sigvart.m@gmail.com> 2018-09-30 00:58:55 +08:00			`The issues being planned and worked on are tracked using GitHub issues. To`
			`participate please visit:`
update README 2017-02-08 05:12:19 +08:00
doc: fix github urls to use the new org Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no> 2020-11-10 23:35:04 +08:00			`[MCUBoot GitHub Issues](https://github.com/mcu-tools/mcuboot/issues)`
Add deprecated warning to Jira and Confluence links This will fix #336 by adding deprecation warning to Jira and Confluence links as these are not used by the project anymore. Signed-off-by: Sigvart M. Hovland <sigvart.m@gmail.com> 2018-09-30 00:58:55 +08:00
			`~~Issues were previously tracked on [MCUboot JIRA](https://runtimeco.atlassian.net/projects/MCUB/summary)`
			`, but it is now deprecated.~~`
update README 2017-02-08 05:12:19 +08:00
Add badges, link url - Add coverity and travis-ci badges - Link title to project url - Remove version information from header text Signed-off-by: Fabio Utzig <utzig@apache.org> 2017-08-11 01:55:27 +08:00			`## Browsing`
update README 2017-02-08 05:12:19 +08:00
Add deprecated warning to Jira and Confluence links This will fix #336 by adding deprecation warning to Jira and Confluence links as these are not used by the project anymore. Signed-off-by: Sigvart M. Hovland <sigvart.m@gmail.com> 2018-09-30 00:58:55 +08:00			`Information and documentation on the bootloader are stored within the source.`
update README 2017-02-08 05:12:19 +08:00
Add deprecated warning to Jira and Confluence links This will fix #336 by adding deprecation warning to Jira and Confluence links as these are not used by the project anymore. Signed-off-by: Sigvart M. Hovland <sigvart.m@gmail.com> 2018-09-30 00:58:55 +08:00			`~~It was previously also documented on confluence:`
			`[MCUBoot Confluence](https://runtimeco.atlassian.net/wiki/discover/all-updates)`
			`however, it is now deprecated and not currently maintained~~`
update README 2017-02-08 05:12:19 +08:00
Add badges, link url - Add coverity and travis-ci badges - Link title to project url - Remove version information from header text Signed-off-by: Fabio Utzig <utzig@apache.org> 2017-08-11 01:55:27 +08:00			`For more information in the source, here are some pointers:`
update README 2017-02-08 05:12:19 +08:00
Use relative links for docs - Also fix imgtool script link Signed-off-by: Fabio Utzig <utzig@apache.org> 2018-02-14 00:20:03 +08:00			`- [boot/bootutil](boot/bootutil): The core of the bootloader itself.`
			`- [boot/boot\_serial](boot/boot_serial): Support for serial upgrade within the bootloader itself.`
			`- [boot/zephyr](boot/zephyr): Port of the bootloader to Zephyr`
			`- [boot/mynewt](boot/mynewt): Mynewt bootloader app`
README.md: Add references to the NuttX port Signed-off-by: Gustavo Henrique Nihei <gustavo.nihei@espressif.com> 2021-08-07 03:15:33 +08:00			`- [boot/nuttx](boot/nuttx): Bootloader application and port of MCUboot interfaces for NuttX.`
readme.md: Add references to the Espressif IDF port. Signed-off-by: Almir Okato <almir.okato@espressif.com> 2021-08-24 01:12:16 +08:00			`- [boot/espressif](boot/espressif): Bootloader application and MCUboot port for Espressif SoCs.`
Use relative links for docs - Also fix imgtool script link Signed-off-by: Fabio Utzig <utzig@apache.org> 2018-02-14 00:20:03 +08:00			`- [imgtool](scripts/imgtool.py): A tool to securely sign firmware images for booting by mcuboot.`
			`- [sim](sim): A bootloader simulator for testing and regression`
update README 2017-02-08 05:12:19 +08:00
Add IRC channel information Signed-off-by: Fabio Utzig <utzig@apache.org> 2017-07-20 20:20:43 +08:00			`## Joining`
update README 2017-02-08 05:12:19 +08:00
Add IRC channel information Signed-off-by: Fabio Utzig <utzig@apache.org> 2017-07-20 20:20:43 +08:00			`Developers welcome!`
update README 2017-02-08 05:12:19 +08:00
doc: Remove outdated IRC links Removed outdated IRC links from index.md and readme.md. Slightly reformatted the final links in index.md and readme.md. Signed-off-by: Francesco Servidio <francesco.servidio@nordicsemi.no> 2021-10-20 20:57:50 +08:00			`* [Our developer mailing list](https://groups.io/g/MCUBoot)`
			`* [Our Slack channel](https://mcuboot.slack.com/) <br />`
			`Get [your invite](https://join.slack.com/t/mcuboot/shared_invite/MjE2NDcwMTQ2MTYyLTE1MDA4MTIzNTAtYzgyZTU0NjFkMg)`