README.md 2.37 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.1.0
Sterling Hughes's avatar
Sterling Hughes committed
10

Fabio Utzig's avatar
Fabio Utzig committed
11
12
13
MCUBoot is a secure bootloader for 32-bit MCUs.   The goal of MCUBoot is to
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

## Roadmap

Fabio Utzig's avatar
Fabio Utzig committed
24
The issues being planned and worked on are tracked on Jira. To participate
Fabio Utzig's avatar
Fabio Utzig committed
25
please visit:
Sterling Hughes's avatar
Sterling Hughes committed
26
27
28

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

Fabio Utzig's avatar
Fabio Utzig committed
29
## Browsing
Sterling Hughes's avatar
Sterling Hughes committed
30
31
32
33
34

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
35
For more information in the source, here are some pointers:
Sterling Hughes's avatar
Sterling Hughes committed
36

Sterling Hughes's avatar
Sterling Hughes committed
37
38
39
- [boot/bootutil](https://github.com/runtimeco/mcuboot/tree/master/boot/bootutil): The core of the bootloader itself.
- [boot/boot\_serial](https://github.com/runtimeco/mcuboot/tree/master/boot/boot_serial): Support for serial upgrade within the bootloader itself.
- [boot/zephyr](https://github.com/runtimeco/mcuboot/tree/master/boot/zephyr): Port of the bootloader to Zephyr
Fabio Utzig's avatar
Fabio Utzig committed
40
- [boot/mynewt](https://github.com/runtimeco/mcuboot/tree/master/boot/mynewt): Mynewt bootloader app
Sterling Hughes's avatar
Sterling Hughes committed
41
42
- [imgtool](https://github.com/runtimeco/mcuboot/tree/master/imgtool): A tool to securely sign firmware images for booting by mcuboot.
- [sim](https://github.com/runtimeco/mcuboot/tree/master/sim): A bootloader simulator for testing and regression
Sterling Hughes's avatar
Sterling Hughes committed
43

Fabio Utzig's avatar
Fabio Utzig committed
44
## Joining
Sterling Hughes's avatar
Sterling Hughes committed
45

Fabio Utzig's avatar
Fabio Utzig committed
46
Developers welcome!
Sterling Hughes's avatar
Sterling Hughes committed
47

Fabio Utzig's avatar
Fabio Utzig committed
48
49
* Our developer mailing list:
  http://lists.runtime.co/mailman/listinfo/dev-mcuboot_lists.runtime.co
Fabio Utzig's avatar
Fabio Utzig committed
50
51
* 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
52
* Our IRC channel: http://irc.freenode.net, #mcuboot