TrustedFirmware Git Browser
Code Review Sign In
review.trustedfirmware.org / mirror / mcuboot / 4023d62849d73333e75d4b8cfa712e21d64a5b70 / . / docs / index.md
blob: d9c70cbda63efd39a4212e59a7cc92a806c668db [file] [log] [blame] [view]
David Brown12b9ded2017-09-11 13:04:34 -0600[diff] [blame]1# MCUboot
2
3## Overview
4
David Browne5f2d1c2017-09-12 11:37:29 -0600[diff] [blame]5MCUboot is a secure bootloader for 32-bit MCUs. The goal of MCUboot is to
David Brownc20b9972017-09-11 13:06:38 -0600[diff] [blame]6define a common infrastructure for the bootloader, system flash layout on
7microcontroller systems, and to provide a secure bootloader that enables
David Brown12b9ded2017-09-11 13:04:34 -0600[diff] [blame]8easy software upgrade.
9
Sigvart M. Hovland68b30532018-09-29 18:58:55 +0200[diff] [blame]10MCUboot is operating system and hardware independent and relies on
David Brown12b9ded2017-09-11 13:04:34 -0600[diff] [blame]11hardware porting layers from the operating system it works with. Currently
12MCUboot works with both the Apache Mynewt, and Zephyr operating systems, but
13more ports are planned in the future. RIOT is currently supported as a boot
14target with a complete port planned.
15
David Brownd2fcc212017-09-11 14:47:48 -0600[diff] [blame]16## Contents
17
Ruth Fuchss4023d622019-11-01 16:32:20 +0100[diff] [blame^]18- General - this document
Fabio Utzig4dce6aa2018-02-12 15:31:32 -0200[diff] [blame]19- [Release notes](release-notes.md)
Ruth Fuchss4023d622019-11-01 16:32:20 +0100[diff] [blame^]20- [Bootloader design](design.md)
21- [Encrypted images](encrypted_images.md)
22- [imgtool](imgtool.md) - image signing and key management
Carles Cufi3b61e702018-01-23 15:43:46 +0100[diff] [blame]23- Usage instructions:
Fabio Utzig4dce6aa2018-02-12 15:31:32 -0200[diff] [blame]24 - [Zephyr](readme-zephyr.md)
25 - [Mynewt](readme-mynewt.md)
26 - [RIOT](readme-riot.md)
Ruth Fuchss4023d622019-11-01 16:32:20 +0100[diff] [blame^]27- [Patch submission](SubmittingPatches.md) - information
28 on how to contribute to mcuboot
David Brownd2fcc212017-09-11 14:47:48 -0600[diff] [blame]29- Testing
Ruth Fuchss4023d622019-11-01 16:32:20 +0100[diff] [blame^]30 - [Zephyr](testplan-zephyr.md) test plan
31 - [mynewt](testplan-mynewt.md) test plan
32- [Release process](release.md)
David Brownd2fcc212017-09-11 14:47:48 -0600[diff] [blame]33
Fabio Utzig4dce6aa2018-02-12 15:31:32 -0200[diff] [blame]34There is also a document about [signed images](signed_images.md) that is out
35of date. You should use `imgtool.py` instead of these documents.
David Brownd2fcc212017-09-11 14:47:48 -0600[diff] [blame]36
David Brown12b9ded2017-09-11 13:04:34 -0600[diff] [blame]37## Roadmap
38
Sigvart M. Hovland68b30532018-09-29 18:58:55 +0200[diff] [blame]39The issues being planned and worked on are tracked using GitHub issues. To participate
David Brownc20b9972017-09-11 13:06:38 -0600[diff] [blame]40please visit:
David Brown12b9ded2017-09-11 13:04:34 -0600[diff] [blame]41
Fabio Utziga3c2f052018-11-15 18:48:59 -0200[diff] [blame]42[MCUboot Issues](https://github.com/JuulLabs-OSS/mcuboot/issues)
Sigvart M. Hovland68b30532018-09-29 18:58:55 +0200[diff] [blame]43
44~~Issues were previously tracked on [MCUboot JIRA](https://runtimeco.atlassian.net/projects/MCUB/summary)
45, but it is now deprecated.~~
David Brown12b9ded2017-09-11 13:04:34 -0600[diff] [blame]46
David Brownc20b9972017-09-11 13:06:38 -0600[diff] [blame]47## Browsing
David Brown12b9ded2017-09-11 13:04:34 -0600[diff] [blame]48
Sigvart M. Hovland68b30532018-09-29 18:58:55 +0200[diff] [blame]49Information and documentation on the bootloader is stored within the source.
David Brown12b9ded2017-09-11 13:04:34 -0600[diff] [blame]50
Sigvart M. Hovland68b30532018-09-29 18:58:55 +0200[diff] [blame]51~~It was previously also documented on confluence: [Confluence page](https://runtimeco.atlassian.net/wiki/discover/all-updates)
52, but it is now deprecated and not currently maintained~~
David Brown12b9ded2017-09-11 13:04:34 -0600[diff] [blame]53
David Brownc20b9972017-09-11 13:06:38 -0600[diff] [blame]54For more information in the source, here are some pointers:
David Brown12b9ded2017-09-11 13:04:34 -0600[diff] [blame]55
Fabio Utziga3c2f052018-11-15 18:48:59 -0200[diff] [blame]56- [boot/bootutil](https://github.com/JuulLabs-OSS/mcuboot/tree/master/boot/bootutil): The core of the bootloader itself.
57- [boot/boot\_serial](https://github.com/JuulLabs-OSS/mcuboot/tree/master/boot/boot_serial): Support for serial upgrade within the bootloader itself.
58- [boot/zephyr](https://github.com/JuulLabs-OSS/mcuboot/tree/master/boot/zephyr): Port of the bootloader to Zephyr
59- [boot/mynewt](https://github.com/JuulLabs-OSS/mcuboot/tree/master/boot/mynewt): Mynewt bootloader app
60- [imgtool](https://github.com/JuulLabs-OSS/mcuboot/tree/master/scripts/imgtool.py): A tool to securely sign firmware images for booting by MCUboot.
61- [sim](https://github.com/JuulLabs-OSS/mcuboot/tree/master/sim): A bootloader simulator for testing and regression
David Brown12b9ded2017-09-11 13:04:34 -0600[diff] [blame]62
63## Joining
64
65Developers welcome!
66
67* [Our developer mailing list](http://lists.runtime.co/mailman/listinfo/dev-mcuboot_lists.runtime.co)
68* [Our Slack channel](https://mcuboot.slack.com/)<br />
69 Get your invite [here!](https://join.slack.com/t/mcuboot/shared_invite/MjE2NDcwMTQ2MTYyLTE1MDA4MTIzNTAtYzgyZTU0NjFkMg)
70* [Our IRC channel](http://irc.freenode.net), channel #mcuboot ([IRC
71 link](irc://chat.freenode.net/#mcuboot)