TrustedFirmware Git Browser
Code Review Sign In
review.trustedfirmware.org / mirror / mcuboot / 05143ce2361829c4f05e036bdb9177676f9bb297 / . / README.md
blob: 53a039710821aa41613f7e3442ef5f74392eb0c2 [file] [log] [blame] [view]
Francesco Servidio4ff0c182021-10-20 15:27:16 +0200[diff] [blame]1# [MCUboot](http://mcuboot.com/)
Fabio Utzig811205e2017-08-10 14:55:27 -0300[diff] [blame]2
Fabio Utzig0be390e2020-11-12 10:45:07 -0300[diff] [blame]3[![Package on PyPI](https://img.shields.io/pypi/v/imgtool.svg)][pypi]
Fabio Utzig811205e2017-08-10 14:55:27 -0300[diff] [blame]4[![Coverity Scan Build Status](https://scan.coverity.com/projects/12307/badge.svg)][coverity]
Fabio Utzig0be390e2020-11-12 10:45:07 -0300[diff] [blame]5[![Build Status (Sim)](https://github.com/mcu-tools/mcuboot/workflows/Sim/badge.svg)][sim]
6[![Build Status (Mynewt)](https://github.com/mcu-tools/mcuboot/workflows/Mynewt/badge.svg)][mynewt]
7[![Publishing Status (imgtool)](https://github.com/mcu-tools/mcuboot/workflows/imgtool/badge.svg)][imgtool]
David Brownfe0bfcf2021-05-14 10:12:10 -0600[diff] [blame]8[![Build Status (Travis CI)](https://img.shields.io/travis/mcu-tools/mcuboot/main.svg?label=travis-ci)][travis]
Fabio Utzig0be390e2020-11-12 10:45:07 -0300[diff] [blame]9[![Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)][license]
Fabio Utzig811205e2017-08-10 14:55:27 -0300[diff] [blame]10
Fabio Utzig0be390e2020-11-12 10:45:07 -0300[diff] [blame]11[pypi]: https://pypi.org/project/imgtool/
Fabio Utzig811205e2017-08-10 14:55:27 -0300[diff] [blame]12[coverity]: https://scan.coverity.com/projects/mcuboot
Fabio Utzigba042982020-11-12 13:17:46 -0300[diff] [blame]13[sim]: https://github.com/mcu-tools/mcuboot/actions?query=workflow:Sim
14[mynewt]: https://github.com/mcu-tools/mcuboot/actions?query=workflow:Mynewt
15[imgtool]: https://github.com/mcu-tools/mcuboot/actions?query=workflow:imgtool
Fabio Utzigde1d72d2020-11-10 12:35:04 -0300[diff] [blame]16[travis]: https://travis-ci.org/mcu-tools/mcuboot
David Brownfe0bfcf2021-05-14 10:12:10 -0600[diff] [blame]17[license]: https://github.com/mcu-tools/mcuboot/blob/main/LICENSE
Sterling Hughesb6903ec2017-02-07 13:12:19 -0800[diff] [blame]18
Francesco Servidio4ff0c182021-10-20 15:27:16 +0200[diff] [blame]19This is MCUboot version 1.8.0
David Browna3be2642017-07-26 19:02:33 -0600[diff] [blame]20
David Brown586c84e2019-12-02 12:02:59 -0700[diff] [blame]21MCUboot is a secure bootloader for 32-bit MCUs. The goal of MCUboot is to
Fabio Utzig811205e2017-08-10 14:55:27 -0300[diff] [blame]22define a common infrastructure for the bootloader, system flash layout on
23microcontroller systems, and to provide a secure bootloader that enables
David Brown586c84e2019-12-02 12:02:59 -0700[diff] [blame]24simple software upgrades.
Sterling Hughesb6903ec2017-02-07 13:12:19 -0800[diff] [blame]25
Sigvart M. Hovland68b30532018-09-29 18:58:55 +0200[diff] [blame]26MCUboot is operating system and hardware independent and relies on
Francesco Servidio4ff0c182021-10-20 15:27:16 +0200[diff] [blame]27hardware porting layers from the operating. Currently, MCUboot works
David Brown586c84e2019-12-02 12:02:59 -0700[diff] [blame]28with both the Apache Mynewt and Zephyr operating systems, but more
29ports are planned in the future. RIOT is currently supported as a boot
Fabio Utzig756ca862017-07-20 13:38:22 -0300[diff] [blame]30target with a complete port planned.
Sterling Hughesb6903ec2017-02-07 13:12:19 -0800[diff] [blame]31
Carles Cufi3b61e702018-01-23 15:43:46 +0100[diff] [blame]32## Using MCUboot
33
34Instructions for different operating systems can be found here:
35- [Zephyr](docs/readme-zephyr.md)
36- [Mynewt](docs/readme-mynewt.md)
37- [RIOT](docs/readme-riot.md)
George Beckstein1c399bb2020-11-05 00:51:09 -0500[diff] [blame]38- [Mbed-OS](docs/readme-mbed.md)
Gustavo Henrique Nihei9d67f012021-08-06 16:15:33 -0300[diff] [blame]39- [NuttX](docs/readme-nuttx.md)
Almir Okatod3632482021-08-23 14:12:16 -0300[diff] [blame]40- [Espressif IDF](docs/readme-espressif.md)
David Brown4cb70cc2020-05-11 14:10:00 -0600[diff] [blame]41- [Simulator](sim/README.rst)
Carles Cufi3b61e702018-01-23 15:43:46 +0100[diff] [blame]42
Sterling Hughesb6903ec2017-02-07 13:12:19 -0800[diff] [blame]43## Roadmap
44
Sigvart M. Hovland68b30532018-09-29 18:58:55 +0200[diff] [blame]45The issues being planned and worked on are tracked using GitHub issues. To
46participate please visit:
Sterling Hughesb6903ec2017-02-07 13:12:19 -0800[diff] [blame]47
Francesco Servidio4ff0c182021-10-20 15:27:16 +0200[diff] [blame]48[MCUboot GitHub Issues](https://github.com/mcu-tools/mcuboot/issues)
Sigvart M. Hovland68b30532018-09-29 18:58:55 +0200[diff] [blame]49
50~~Issues were previously tracked on [MCUboot JIRA](https://runtimeco.atlassian.net/projects/MCUB/summary)
51, but it is now deprecated.~~
Sterling Hughesb6903ec2017-02-07 13:12:19 -0800[diff] [blame]52
Fabio Utzig811205e2017-08-10 14:55:27 -0300[diff] [blame]53## Browsing
Sterling Hughesb6903ec2017-02-07 13:12:19 -0800[diff] [blame]54
Sigvart M. Hovland68b30532018-09-29 18:58:55 +0200[diff] [blame]55Information and documentation on the bootloader are stored within the source.
Sterling Hughesb6903ec2017-02-07 13:12:19 -0800[diff] [blame]56
Sigvart M. Hovland68b30532018-09-29 18:58:55 +0200[diff] [blame]57~~It was previously also documented on confluence:
Francesco Servidio4ff0c182021-10-20 15:27:16 +0200[diff] [blame]58[MCUboot Confluence](https://runtimeco.atlassian.net/wiki/discover/all-updates)
Sigvart M. Hovland68b30532018-09-29 18:58:55 +0200[diff] [blame]59however, it is now deprecated and not currently maintained~~
Sterling Hughesb6903ec2017-02-07 13:12:19 -0800[diff] [blame]60
Fabio Utzig811205e2017-08-10 14:55:27 -0300[diff] [blame]61For more information in the source, here are some pointers:
Sterling Hughesb6903ec2017-02-07 13:12:19 -0800[diff] [blame]62
Fabio Utzigb519ed02018-02-13 14:20:03 -0200[diff] [blame]63- [boot/bootutil](boot/bootutil): The core of the bootloader itself.
64- [boot/boot\_serial](boot/boot_serial): Support for serial upgrade within the bootloader itself.
65- [boot/zephyr](boot/zephyr): Port of the bootloader to Zephyr
66- [boot/mynewt](boot/mynewt): Mynewt bootloader app
Gustavo Henrique Nihei9d67f012021-08-06 16:15:33 -0300[diff] [blame]67- [boot/nuttx](boot/nuttx): Bootloader application and port of MCUboot interfaces for NuttX.
Almir Okatod3632482021-08-23 14:12:16 -0300[diff] [blame]68- [boot/espressif](boot/espressif): Bootloader application and MCUboot port for Espressif SoCs.
Francesco Servidio4ff0c182021-10-20 15:27:16 +0200[diff] [blame]69- [imgtool](scripts/imgtool.py): A tool to securely sign firmware images for booting by MCUboot.
Fabio Utzigb519ed02018-02-13 14:20:03 -0200[diff] [blame]70- [sim](sim): A bootloader simulator for testing and regression
Sterling Hughesb6903ec2017-02-07 13:12:19 -0800[diff] [blame]71
Fabio Utzig74023742017-07-20 09:20:43 -0300[diff] [blame]72## Joining
Sterling Hughesb6903ec2017-02-07 13:12:19 -0800[diff] [blame]73
Fabio Utzig74023742017-07-20 09:20:43 -0300[diff] [blame]74Developers welcome!
Sterling Hughesb6903ec2017-02-07 13:12:19 -0800[diff] [blame]75
Francesco Servidio18488632021-10-20 14:57:50 +0200[diff] [blame]76* [Our developer mailing list](https://groups.io/g/MCUBoot)
77* [Our Slack channel](https://mcuboot.slack.com/) <br />
78 Get [your invite](https://join.slack.com/t/mcuboot/shared_invite/MjE2NDcwMTQ2MTYyLTE1MDA4MTIzNTAtYzgyZTU0NjFkMg)