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