1# MCUboot
2
3MCUboot is a secure bootloader for 32-bits microcontrollers.
4
5## Overview
6
7MCUboot defines a common infrastructure for the bootloader and the system flash
8layout on microcontroller systems, and provides a secure bootloader that
9enables easy software upgrade.
10
11MCUboot is not dependent on any specific operating system and hardware and
12relies on hardware porting layers from the operating system it works with.
13Currently MCUboot works with the following operating systems and SoCs:
14- [Zephyr](https://www.zephyrproject.org/)
15- [Apache Mynewt](https://mynewt.apache.org/)
16- [Apache NuttX](https://nuttx.apache.org/)
17- [RIOT](https://www.riot-os.org/)
18- [Mbed OS](https://os.mbed.com/)
19- [Espressif](https://www.espressif.com/)
20- [Cypress/Infineon](https://www.cypress.com/)
21
22RIOT is supported only as a boot target. We will accept any new port
23contributed by the community once it is good enough.
24
25MCUboot is an open governance project. See the [membership
26list](https://github.com/mcu-tools/mcuboot/wiki/Members) for current
27members, and the
28[project charter](https://github.com/mcu-tools/mcuboot/wiki/MCUboot-Project-Charter)
29for more details.
30
31## Documentation
32
33The MCUboot documentation is composed of the following pages:
34
35- General - this document
36- [Release notes](release-notes.md)
37- [Bootloader design](design.md)
38- [Encrypted images](encrypted_images.md)
39- [imgtool](imgtool.md) - image signing and key management
40- [ECDSA](ecdsa.md) - information about ECDSA signature formats
41- [Serial Recovery](serial_recovery.md) - MCUmgr as the serial recovery protocol
42- Usage instructions:
43  - [Zephyr](readme-zephyr.md)
44  - [Apache Mynewt](readme-mynewt.md)
45  - [Apache NuttX](readme-nuttx.md)
46  - [RIOT](readme-riot.md)
47  - [Mbed OS](readme-mbed.md)
48  - [Espressif](readme-espressif.md)
49  - [Cypress/Infineon](https://github.com/mcu-tools/mcuboot/tree/main/boot/cypress/README.md)
50  - [Simulator](https://github.com/mcu-tools/mcuboot/tree/main/sim/README.rst)
51- Testing
52  - [Zephyr](testplan-zephyr.md) - Zephyr test plan
53  - [Apache Mynewt](testplan-mynewt.md) - Apache Mynewt test plan
54- [Release process](release.md)
55- [Project security policy](SECURITY.md)
56- [Patch submission](SubmittingPatches.md) - information
57  on how to contribute to MCUboot
58
59The documentation page about [signed images](signed_images.md) is currently
60outdated. Follow the instructions in [imgtool](imgtool.md) instead.
61
62## Roadmap
63
64The issues being planned and worked on are tracked using GitHub issues. To
65give your input, visit [MCUboot GitHub
66Issues](https://github.com/mcu-tools/mcuboot/issues).
67
68## Source files
69
70You can find additional documentation on the bootloader in the source files.
71For more information, use the following links:
72- [boot/bootutil](https://github.com/mcu-tools/mcuboot/tree/main/boot/bootutil) - The core of the bootloader itself.
73- [boot/boot\_serial](https://github.com/mcu-tools/mcuboot/tree/main/boot/boot_serial) - Support for serial upgrade within the bootloader itself.
74- [boot/zephyr](https://github.com/mcu-tools/mcuboot/tree/main/boot/zephyr) - Port of the bootloader to Zephyr.
75- [boot/mynewt](https://github.com/mcu-tools/mcuboot/tree/main/boot/mynewt) - Bootloader application for Apache Mynewt.
76- [boot/nuttx](https://github.com/mcu-tools/mcuboot/tree/main/boot/nuttx) - Bootloader application and port of MCUboot interfaces for Apache NuttX.
77- [boot/mbed](https://github.com/mcu-tools/mcuboot/tree/main/boot/mbed) - Port of the bootloader to Mbed OS.
78- [boot/espressif](https://github.com/mcu-tools/mcuboot/tree/main/boot/espressif) - Bootloader application and MCUboot port for Espressif SoCs.
79- [boot/cypress](https://github.com/mcu-tools/mcuboot/tree/main/boot/cypress) - Bootloader application and MCUboot port for Cypress/Infineon SoCs.
80- [imgtool](https://github.com/mcu-tools/mcuboot/tree/main/scripts/imgtool.py) - A tool to securely sign firmware images for booting by MCUboot.
81- [sim](https://github.com/mcu-tools/mcuboot/tree/main/sim) - A bootloader simulator for testing and regression.
82
83## Joining the project
84
85Developers are welcome!
86
87Use the following links to join or see more about the project:
88
89* [Our developer mailing list](https://groups.io/g/MCUBoot)
90* [Our Slack channel](https://mcuboot.slack.com/) <br />
91  Get [your invite](https://join.slack.com/t/mcuboot/shared_invite/MjE2NDcwMTQ2MTYyLTE1MDA4MTIzNTAtYzgyZTU0NjFkMg)
92* [Current members](https://github.com/mcu-tools/mcuboot/wiki/Members)
93* [Project charter](https://github.com/mcu-tools/mcuboot/wiki/MCUboot-Project-Charter)
94