README.md 3.4 KB
Newer Older
Fabio Utzig's avatar
Fabio Utzig committed
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
8
9
[![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]
[![Build Status (Travis CI)](https://img.shields.io/travis/mcu-tools/mcuboot/master.svg?label=travis-ci)][travis]
[![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:.github/workflows/sim.yaml
[mynewt]: https://github.com/mcu-tools/mcuboot/actions?query=workflow:.github/workflows/mynewt.yaml
[imgtool]: https://github.com/mcu-tools/mcuboot/actions?query=workflow:.github/workflows/imgtool.yaml
16
[travis]: https://travis-ci.org/mcu-tools/mcuboot
17
[license]: https://github.com/mcu-tools/mcuboot/blob/master/LICENSE
David Brown's avatar
David Brown committed
18

Andrzej Puzdrowski's avatar
Andrzej Puzdrowski committed
19
This is mcuboot version 1.7.0-rc2
Sterling Hughes's avatar
Sterling Hughes committed
20

21
MCUboot is a secure bootloader for 32-bit MCUs. The goal of MCUboot is to
Fabio Utzig's avatar
Fabio Utzig committed
22
23
define a common infrastructure for the bootloader, system flash layout on
microcontroller systems, and to provide a secure bootloader that enables
24
simple software upgrades.
Sterling Hughes's avatar
Sterling Hughes committed
25

26
MCUboot is operating system and hardware independent and relies on
27
28
29
hardware porting layers from the operating. Currently, mcuboot works
with both the Apache Mynewt and Zephyr operating systems, but more
ports are planned in the future. RIOT is currently supported as a boot
Fabio Utzig's avatar
Fabio Utzig committed
30
target with a complete port planned.
Sterling Hughes's avatar
Sterling Hughes committed
31

32
33
34
35
36
37
## Using MCUboot

Instructions for different operating systems can be found here:
- [Zephyr](docs/readme-zephyr.md)
- [Mynewt](docs/readme-mynewt.md)
- [RIOT](docs/readme-riot.md)
38
- [Mbed-OS](docs/readme-mbed.md)
39
- [Simulator](sim/README.rst)
40

Sterling Hughes's avatar
Sterling Hughes committed
41
42
## Roadmap

43
44
The issues being planned and worked on are tracked using GitHub issues. To
participate please visit:
Sterling Hughes's avatar
Sterling Hughes committed
45

46
[MCUBoot GitHub Issues](https://github.com/mcu-tools/mcuboot/issues)
47
48
49

~~Issues were previously tracked on [MCUboot JIRA](https://runtimeco.atlassian.net/projects/MCUB/summary)
, but it is now deprecated.~~
Sterling Hughes's avatar
Sterling Hughes committed
50

Fabio Utzig's avatar
Fabio Utzig committed
51
## Browsing
Sterling Hughes's avatar
Sterling Hughes committed
52

53
Information and documentation on the bootloader are stored within the source.
Sterling Hughes's avatar
Sterling Hughes committed
54

55
56
57
~~It was previously also documented on confluence:
[MCUBoot Confluence](https://runtimeco.atlassian.net/wiki/discover/all-updates)
however, it is now deprecated and not currently maintained~~
Sterling Hughes's avatar
Sterling Hughes committed
58

Fabio Utzig's avatar
Fabio Utzig committed
59
For more information in the source, here are some pointers:
Sterling Hughes's avatar
Sterling Hughes committed
60

Fabio Utzig's avatar
Fabio Utzig committed
61
62
63
64
65
66
- [boot/bootutil](boot/bootutil): The core of the bootloader itself.
- [boot/boot\_serial](boot/boot_serial): Support for serial upgrade within the bootloader itself.
- [boot/zephyr](boot/zephyr): Port of the bootloader to Zephyr
- [boot/mynewt](boot/mynewt): Mynewt bootloader app
- [imgtool](scripts/imgtool.py): A tool to securely sign firmware images for booting by mcuboot.
- [sim](sim): A bootloader simulator for testing and regression
Sterling Hughes's avatar
Sterling Hughes committed
67

Fabio Utzig's avatar
Fabio Utzig committed
68
## Joining
Sterling Hughes's avatar
Sterling Hughes committed
69

Fabio Utzig's avatar
Fabio Utzig committed
70
Developers welcome!
Sterling Hughes's avatar
Sterling Hughes committed
71

Fabio Utzig's avatar
Fabio Utzig committed
72
* Our developer mailing list:
David Brown's avatar
David Brown committed
73
  https://groups.io/g/mcuboot
Fabio Utzig's avatar
Fabio Utzig committed
74
75
* Our Slack channel: https://mcuboot.slack.com/ <br />
  Get your invite [here!](https://join.slack.com/t/mcuboot/shared_invite/MjE2NDcwMTQ2MTYyLTE1MDA4MTIzNTAtYzgyZTU0NjFkMg)
Fabio Utzig's avatar
Fabio Utzig committed
76
* Our IRC channel: http://irc.freenode.net, #mcuboot