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

Fabio Utzig's avatar
Fabio Utzig committed
3
4
5
6
7
[![Coverity Scan Build Status](https://scan.coverity.com/projects/12307/badge.svg)][coverity]
[![Build/Test](https://img.shields.io/travis/runtimeco/mcuboot/master.svg?label=travis-ci)][travis]

[coverity]: https://scan.coverity.com/projects/mcuboot
[travis]: https://travis-ci.org/runtimeco/mcuboot
David Brown's avatar
David Brown committed
8

Fabio Utzig's avatar
Fabio Utzig committed
9
This is mcuboot, version 1.2.0
Sterling Hughes's avatar
Sterling Hughes committed
10

Carles Cufi's avatar
Carles Cufi committed
11
MCUboot is a secure bootloader for 32-bit MCUs.   The goal of MCUboot is to
Fabio Utzig's avatar
Fabio Utzig committed
12
13
define a common infrastructure for the bootloader, system flash layout on
microcontroller systems, and to provide a secure bootloader that enables
Sterling Hughes's avatar
Sterling Hughes committed
14
15
easy software upgrade.

Fabio Utzig's avatar
Fabio Utzig committed
16
MCUboot is operating system and hardware independent, and relies on
Sterling Hughes's avatar
Sterling Hughes committed
17
18
hardware porting layers from the operating system it works with.  Currently
mcuboot works with both the Apache Mynewt, and Zephyr operating systems, but
Fabio Utzig's avatar
Fabio Utzig committed
19
more ports are planned in the future. RIOT is currently supported as a boot
Fabio Utzig's avatar
Fabio Utzig committed
20
target with a complete port planned.
Sterling Hughes's avatar
Sterling Hughes committed
21

22
23
24
25
26
27
28
## 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)

Sterling Hughes's avatar
Sterling Hughes committed
29
30
## Roadmap

Fabio Utzig's avatar
Fabio Utzig committed
31
The issues being planned and worked on are tracked on Jira. To participate
Fabio Utzig's avatar
Fabio Utzig committed
32
please visit:
Sterling Hughes's avatar
Sterling Hughes committed
33
34
35

https://runtimeco.atlassian.net/projects/MCUB/summary

Fabio Utzig's avatar
Fabio Utzig committed
36
## Browsing
Sterling Hughes's avatar
Sterling Hughes committed
37
38
39
40
41

Information and documentation on the bootloader is stored within the source, and on confluence:

https://runtimeco.atlassian.net/wiki/discover/all-updates

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

Fabio Utzig's avatar
Fabio Utzig committed
44
45
46
47
48
49
- [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
50

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

Fabio Utzig's avatar
Fabio Utzig committed
53
Developers welcome!
Sterling Hughes's avatar
Sterling Hughes committed
54

Fabio Utzig's avatar
Fabio Utzig committed
55
56
* Our developer mailing list:
  http://lists.runtime.co/mailman/listinfo/dev-mcuboot_lists.runtime.co
Fabio Utzig's avatar
Fabio Utzig committed
57
58
* 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
59
* Our IRC channel: http://irc.freenode.net, #mcuboot