1# [MCUboot](http://mcuboot.com/)
2
3[![Package on PyPI](https://img.shields.io/pypi/v/imgtool.svg)][pypi]
4[![Coverity Scan Build Status](https://scan.coverity.com/projects/12307/badge.svg)][coverity]
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[![Build Status (Espressif)](https://github.com/mcu-tools/mcuboot/workflows/Espressif/badge.svg)][espressif]
8[![Publishing Status (imgtool)](https://github.com/mcu-tools/mcuboot/workflows/imgtool/badge.svg)][imgtool]
9[![Build Status (Travis CI)](https://img.shields.io/travis/mcu-tools/mcuboot/main.svg?label=travis-ci)][travis]
10[![Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)][license]
11
12[pypi]: https://pypi.org/project/imgtool/
13[coverity]: https://scan.coverity.com/projects/mcuboot
14[sim]: https://github.com/mcu-tools/mcuboot/actions?query=workflow:Sim
15[mynewt]: https://github.com/mcu-tools/mcuboot/actions?query=workflow:Mynewt
16[espressif]: https://github.com/mcu-tools/mcuboot/actions?query=workflow:Espressif
17[imgtool]: https://github.com/mcu-tools/mcuboot/actions?query=workflow:imgtool
18[travis]: https://travis-ci.org/mcu-tools/mcuboot
19[license]: https://github.com/mcu-tools/mcuboot/blob/main/LICENSE
20
21This is MCUboot version 2.1.0-dev
22
23MCUboot is a secure bootloader for 32-bits microcontrollers. It defines a
24common infrastructure for the bootloader and the system flash layout on
25microcontroller systems, and provides a secure bootloader that enables easy
26software upgrade.
27
28MCUboot is not dependent on any specific operating system and hardware and
29relies on hardware porting layers from the operating system it works with.
30Currently, MCUboot works with the following operating systems and SoCs:
31- [Zephyr](https://www.zephyrproject.org/)
32- [Apache Mynewt](https://mynewt.apache.org/)
33- [Apache NuttX](https://nuttx.apache.org/)
34- [RIOT](https://www.riot-os.org/)
35- [Mbed OS](https://os.mbed.com/)
36- [Espressif](https://www.espressif.com/)
37- [Cypress/Infineon](https://www.cypress.com/)
38
39RIOT is supported only as a boot target. We will accept any new
40port contributed by the community once it is good enough.
41
42## MCUboot How-tos
43
44See the following pages for instructions on using MCUboot with different
45operating systems and SoCs:
46- [Zephyr](docs/readme-zephyr.md)
47- [Apache Mynewt](docs/readme-mynewt.md)
48- [Apache NuttX](docs/readme-nuttx.md)
49- [RIOT](docs/readme-riot.md)
50- [Mbed OS](docs/readme-mbed.md)
51- [Espressif](docs/readme-espressif.md)
52- [Cypress/Infineon](boot/cypress/README.md)
53
54There are also instructions for the [Simulator](sim/README.rst).
55
56## Roadmap
57
58The issues being planned and worked on are tracked using GitHub issues. To
59give your input, visit [MCUboot GitHub
60Issues](https://github.com/mcu-tools/mcuboot/issues).
61
62## Source files
63
64You can find additional documentation on the bootloader in the source files.
65For more information, use the following links:
66- [boot/bootutil](https://github.com/mcu-tools/mcuboot/tree/main/boot/bootutil) - The core of the bootloader itself.
67- [boot/boot\_serial](https://github.com/mcu-tools/mcuboot/tree/main/boot/boot_serial) - Support for serial upgrade within the bootloader itself.
68- [boot/zephyr](https://github.com/mcu-tools/mcuboot/tree/main/boot/zephyr) - Port of the bootloader to Zephyr.
69- [boot/mynewt](https://github.com/mcu-tools/mcuboot/tree/main/boot/mynewt) - Bootloader application for Apache Mynewt.
70- [boot/nuttx](https://github.com/mcu-tools/mcuboot/tree/main/boot/nuttx) - Bootloader application and port of MCUboot interfaces for Apache NuttX.
71- [boot/mbed](https://github.com/mcu-tools/mcuboot/tree/main/boot/mbed) - Port of the bootloader to Mbed OS.
72- [boot/espressif](https://github.com/mcu-tools/mcuboot/tree/main/boot/espressif) - Bootloader application and MCUboot port for Espressif SoCs.
73- [boot/cypress](https://github.com/mcu-tools/mcuboot/tree/main/boot/cypress) - Bootloader application and MCUboot port for Cypress/Infineon SoCs.
74- [imgtool](https://github.com/mcu-tools/mcuboot/tree/main/scripts/imgtool.py) - A tool to securely sign firmware images for booting by MCUboot.
75- [sim](https://github.com/mcu-tools/mcuboot/tree/main/sim) - A bootloader simulator for testing and regression.
76
77## Joining the project
78
79Developers are welcome!
80
81Use the following links to join or see more about the project:
82
83* [Our developer mailing list](https://groups.io/g/MCUBoot)
84* [Our Slack channel](https://mcuboot.slack.com/) <br />
85  Get [your invite](https://join.slack.com/t/mcuboot/shared_invite/MjE2NDcwMTQ2MTYyLTE1MDA4MTIzNTAtYzgyZTU0NjFkMg)
86