README.md 4.36 KB
Newer Older
1
# [MCUboot](http://mcuboot.com/)
Sterling Hughes's avatar
Sterling Hughes committed
2

3
[![Package on PyPI](https://img.shields.io/pypi/v/imgtool.svg)][pypi]
Fabio Utzig's avatar
Fabio Utzig committed
4
[![Coverity Scan Build Status](https://scan.coverity.com/projects/12307/badge.svg)][coverity]
5
6
7
[![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]
David Brown's avatar
David Brown committed
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]
Fabio Utzig's avatar
Fabio Utzig committed
10

11
[pypi]: https://pypi.org/project/imgtool/
Fabio Utzig's avatar
Fabio Utzig committed
12
[coverity]: https://scan.coverity.com/projects/mcuboot
13
14
15
[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
16
[travis]: https://travis-ci.org/mcu-tools/mcuboot
David Brown's avatar
David Brown committed
17
[license]: https://github.com/mcu-tools/mcuboot/blob/main/LICENSE
David Brown's avatar
David Brown committed
18

David Brown's avatar
David Brown committed
19
This is MCUboot version 1.9.0
Sterling Hughes's avatar
Sterling Hughes committed
20

21
22
23
24
25
26
27
28
29
30
31
32
33
MCUboot is a secure bootloader for 32-bits microcontrollers. It defines a
common infrastructure for the bootloader and the system flash layout on
microcontroller systems, and provides a secure bootloader that enables easy
software upgrade.

MCUboot is not dependent on any specific operating system and hardware and
relies on hardware porting layers from the operating system it works with.
Currently, MCUboot works with the following operating systems and SoCs:
- [Zephyr](https://www.zephyrproject.org/)
- [Apache Mynewt](https://mynewt.apache.org/)
- [Apache NuttX](https://nuttx.apache.org/)
- [RIOT](https://www.riot-os.org/)
- [Mbed OS](https://os.mbed.com/)
34
- [Espressif](https://www.espressif.com/)
35
36
37
38
39
40
41
42
43
- [Cypress/Infineon](https://www.cypress.com/)

RIOT is supported only as a boot target. We will accept any new
port contributed by the community once it is good enough.

## MCUboot How-tos

See the following pages for instructions on using MCUboot with different
operating systems and SoCs:
44
- [Zephyr](docs/readme-zephyr.md)
45
46
- [Apache Mynewt](docs/readme-mynewt.md)
- [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
51
52
- [Cypress/Infineon](boot/cypress/readme.md)

There are also instructions for the [Simulator](sim/README.rst).
53

Sterling Hughes's avatar
Sterling Hughes committed
54
55
## Roadmap

56
The issues being planned and worked on are tracked using GitHub issues. To
57
58
give your input, visit [MCUboot GitHub
Issues](https://github.com/mcu-tools/mcuboot/issues).
Sterling Hughes's avatar
Sterling Hughes committed
59

60
## Source files
Sterling Hughes's avatar
Sterling Hughes committed
61

62
63
64
65
66
67
68
69
70
71
72
73
You can find additional documentation on the bootloader in the source files.
For more information, use the following links:
- [boot/bootutil](https://github.com/mcu-tools/mcuboot/tree/main/boot/bootutil) - The core of the bootloader itself.
- [boot/boot\_serial](https://github.com/mcu-tools/mcuboot/tree/main/boot/boot_serial) - Support for serial upgrade within the bootloader itself.
- [boot/zephyr](https://github.com/mcu-tools/mcuboot/tree/main/boot/zephyr) - Port of the bootloader to Zephyr.
- [boot/mynewt](https://github.com/mcu-tools/mcuboot/tree/main/boot/mynewt) - Bootloader application for Apache Mynewt.
- [boot/nuttx](https://github.com/mcu-tools/mcuboot/tree/main/boot/nuttx) - Bootloader application and port of MCUboot interfaces for Apache NuttX.
- [boot/mbed](https://github.com/mcu-tools/mcuboot/tree/main/boot/mbed) - Port of the bootloader to Mbed OS.
- [boot/espressif](https://github.com/mcu-tools/mcuboot/tree/main/boot/espressif) - Bootloader application and MCUboot port for Espressif SoCs.
- [boot/cypress](https://github.com/mcu-tools/mcuboot/tree/main/boot/cypress) - Bootloader application and MCUboot port for Cypress/Infineon SoCs.
- [imgtool](https://github.com/mcu-tools/mcuboot/tree/main/scripts/imgtool.py) - A tool to securely sign firmware images for booting by MCUboot.
- [sim](https://github.com/mcu-tools/mcuboot/tree/main/sim) - A bootloader simulator for testing and regression.
Sterling Hughes's avatar
Sterling Hughes committed
74

75
## Joining the project
Sterling Hughes's avatar
Sterling Hughes committed
76

77
Developers are welcome!
Sterling Hughes's avatar
Sterling Hughes committed
78

79
Use the following links to join or see more about the project:
Sterling Hughes's avatar
Sterling Hughes committed
80

81
82
83
* [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)