TrustedFirmware Git Browser
Code Review Sign In
review.trustedfirmware.org / mirror / mcuboot / 30898fc0038734df274e301a2f5471cb5f6c54c1 / . / README.md
blob: 5d307930ec24d62c7afe50be6590b5aa82605771 [file] [log] [blame] [view]
Fabio Utzig811205e2017-08-10 14:55:27 -0300[diff] [blame]1# [mcuboot](http://mcuboot.com/)
2
3[![Coverity Scan Build Status](https://scan.coverity.com/projects/12307/badge.svg)][coverity]
Fabio Utziga3c2f052018-11-15 18:48:59 -0200[diff] [blame]4[![Build/Test](https://img.shields.io/travis/JuulLabs-OSS/mcuboot/master.svg?label=travis-ci)][travis]
Fabio Utzig811205e2017-08-10 14:55:27 -0300[diff] [blame]5
6[coverity]: https://scan.coverity.com/projects/mcuboot
Fabio Utziga3c2f052018-11-15 18:48:59 -0200[diff] [blame]7[travis]: https://travis-ci.org/JuulLabs-OSS/mcuboot
Sterling Hughesb6903ec2017-02-07 13:12:19 -0800[diff] [blame]8
Andrzej Puzdrowski69344632020-10-30 15:36:49 +0100[diff] [blame]9This is mcuboot version 1.7.0-rc1
David Browna3be2642017-07-26 19:02:33 -0600[diff] [blame]10
David Brown586c84e2019-12-02 12:02:59 -0700[diff] [blame]11MCUboot is a secure bootloader for 32-bit MCUs. The goal of MCUboot is to
Fabio Utzig811205e2017-08-10 14:55:27 -0300[diff] [blame]12define a common infrastructure for the bootloader, system flash layout on
13microcontroller systems, and to provide a secure bootloader that enables
David Brown586c84e2019-12-02 12:02:59 -0700[diff] [blame]14simple software upgrades.
Sterling Hughesb6903ec2017-02-07 13:12:19 -0800[diff] [blame]15
Sigvart M. Hovland68b30532018-09-29 18:58:55 +0200[diff] [blame]16MCUboot is operating system and hardware independent and relies on
David Brown586c84e2019-12-02 12:02:59 -0700[diff] [blame]17hardware porting layers from the operating. Currently, mcuboot works
18with both the Apache Mynewt and Zephyr operating systems, but more
19ports are planned in the future. RIOT is currently supported as a boot
Fabio Utzig756ca862017-07-20 13:38:22 -0300[diff] [blame]20target with a complete port planned.
Sterling Hughesb6903ec2017-02-07 13:12:19 -0800[diff] [blame]21
Carles Cufi3b61e702018-01-23 15:43:46 +0100[diff] [blame]22## Using MCUboot
23
24Instructions for different operating systems can be found here:
25- [Zephyr](docs/readme-zephyr.md)
26- [Mynewt](docs/readme-mynewt.md)
27- [RIOT](docs/readme-riot.md)
David Brown4cb70cc2020-05-11 14:10:00 -0600[diff] [blame]28- [Simulator](sim/README.rst)
Carles Cufi3b61e702018-01-23 15:43:46 +0100[diff] [blame]29
Sterling Hughesb6903ec2017-02-07 13:12:19 -0800[diff] [blame]30## Roadmap
31
Sigvart M. Hovland68b30532018-09-29 18:58:55 +0200[diff] [blame]32The issues being planned and worked on are tracked using GitHub issues. To
33participate please visit:
Sterling Hughesb6903ec2017-02-07 13:12:19 -0800[diff] [blame]34
Fabio Utziga3c2f052018-11-15 18:48:59 -0200[diff] [blame]35[MCUBoot GitHub Issues](https://github.com/JuulLabs-OSS/mcuboot/issues)
Sigvart M. Hovland68b30532018-09-29 18:58:55 +0200[diff] [blame]36
37~~Issues were previously tracked on [MCUboot JIRA](https://runtimeco.atlassian.net/projects/MCUB/summary)
38, but it is now deprecated.~~
Sterling Hughesb6903ec2017-02-07 13:12:19 -0800[diff] [blame]39
Fabio Utzig811205e2017-08-10 14:55:27 -0300[diff] [blame]40## Browsing
Sterling Hughesb6903ec2017-02-07 13:12:19 -0800[diff] [blame]41
Sigvart M. Hovland68b30532018-09-29 18:58:55 +0200[diff] [blame]42Information and documentation on the bootloader are stored within the source.
Sterling Hughesb6903ec2017-02-07 13:12:19 -0800[diff] [blame]43
Sigvart M. Hovland68b30532018-09-29 18:58:55 +0200[diff] [blame]44~~It was previously also documented on confluence:
45[MCUBoot Confluence](https://runtimeco.atlassian.net/wiki/discover/all-updates)
46however, it is now deprecated and not currently maintained~~
Sterling Hughesb6903ec2017-02-07 13:12:19 -0800[diff] [blame]47
Fabio Utzig811205e2017-08-10 14:55:27 -0300[diff] [blame]48For more information in the source, here are some pointers:
Sterling Hughesb6903ec2017-02-07 13:12:19 -0800[diff] [blame]49
Fabio Utzigb519ed02018-02-13 14:20:03 -0200[diff] [blame]50- [boot/bootutil](boot/bootutil): The core of the bootloader itself.
51- [boot/boot\_serial](boot/boot_serial): Support for serial upgrade within the bootloader itself.
52- [boot/zephyr](boot/zephyr): Port of the bootloader to Zephyr
53- [boot/mynewt](boot/mynewt): Mynewt bootloader app
54- [imgtool](scripts/imgtool.py): A tool to securely sign firmware images for booting by mcuboot.
55- [sim](sim): A bootloader simulator for testing and regression
Sterling Hughesb6903ec2017-02-07 13:12:19 -0800[diff] [blame]56
Fabio Utzig74023742017-07-20 09:20:43 -0300[diff] [blame]57## Joining
Sterling Hughesb6903ec2017-02-07 13:12:19 -0800[diff] [blame]58
Fabio Utzig74023742017-07-20 09:20:43 -0300[diff] [blame]59Developers welcome!
Sterling Hughesb6903ec2017-02-07 13:12:19 -0800[diff] [blame]60
Fabio Utzig74023742017-07-20 09:20:43 -0300[diff] [blame]61* Our developer mailing list:
David Browna222bf32020-02-07 11:53:06 -0700[diff] [blame]62 https://groups.io/g/mcuboot
Fabio Utzig83e59292017-07-24 07:59:26 -0300[diff] [blame]63* Our Slack channel: https://mcuboot.slack.com/ <br />
64 Get your invite [here!](https://join.slack.com/t/mcuboot/shared_invite/MjE2NDcwMTQ2MTYyLTE1MDA4MTIzNTAtYzgyZTU0NjFkMg)
Fabio Utzig74023742017-07-20 09:20:43 -0300[diff] [blame]65* Our IRC channel: http://irc.freenode.net, #mcuboot