2017-08-11 01:55:27 +08:00
|
|
|
# [mcuboot](http://mcuboot.com/)
|
2017-02-08 05:12:19 +08:00
|
|
|
|
2017-08-11 01:55:27 +08:00
|
|
|
[][coverity]
|
2018-11-16 04:48:59 +08:00
|
|
|
[][travis]
|
2017-08-11 01:55:27 +08:00
|
|
|
|
|
|
|
|
[coverity]: https://scan.coverity.com/projects/mcuboot
|
2018-11-16 04:48:59 +08:00
|
|
|
[travis]: https://travis-ci.org/JuulLabs-OSS/mcuboot
|
2017-07-27 09:02:33 +08:00
|
|
|
|
2019-07-04 20:45:52 +08:00
|
|
|
This is mcuboot, version 1.3.1
|
2017-02-08 05:12:19 +08:00
|
|
|
|
2018-01-30 01:33:20 +08:00
|
|
|
MCUboot is a secure bootloader for 32-bit MCUs. The goal of MCUboot is to
|
2017-08-11 01:55:27 +08:00
|
|
|
define a common infrastructure for the bootloader, system flash layout on
|
|
|
|
|
microcontroller systems, and to provide a secure bootloader that enables
|
2017-02-08 05:12:19 +08:00
|
|
|
easy software upgrade.
|
|
|
|
|
|
2018-09-30 00:58:55 +08:00
|
|
|
MCUboot is operating system and hardware independent and relies on
|
|
|
|
|
hardware porting layers from the operating system it works with. Currently,
|
2017-02-08 05:12:19 +08:00
|
|
|
mcuboot works with both the Apache Mynewt, and Zephyr operating systems, but
|
2017-07-20 19:59:51 +08:00
|
|
|
more ports are planned in the future. RIOT is currently supported as a boot
|
2017-07-21 00:38:22 +08:00
|
|
|
target with a complete port planned.
|
2017-02-08 05:12:19 +08:00
|
|
|
|
2018-01-23 22:43:46 +08:00
|
|
|
## 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)
|
|
|
|
|
|
2017-02-08 05:12:19 +08:00
|
|
|
## Roadmap
|
|
|
|
|
|
2018-09-30 00:58:55 +08:00
|
|
|
The issues being planned and worked on are tracked using GitHub issues. To
|
|
|
|
|
participate please visit:
|
2017-02-08 05:12:19 +08:00
|
|
|
|
2018-11-16 04:48:59 +08:00
|
|
|
[MCUBoot GitHub Issues](https://github.com/JuulLabs-OSS/mcuboot/issues)
|
2018-09-30 00:58:55 +08:00
|
|
|
|
|
|
|
|
~~Issues were previously tracked on [MCUboot JIRA](https://runtimeco.atlassian.net/projects/MCUB/summary)
|
|
|
|
|
, but it is now deprecated.~~
|
2017-02-08 05:12:19 +08:00
|
|
|
|
2017-08-11 01:55:27 +08:00
|
|
|
## Browsing
|
2017-02-08 05:12:19 +08:00
|
|
|
|
2018-09-30 00:58:55 +08:00
|
|
|
Information and documentation on the bootloader are stored within the source.
|
2017-02-08 05:12:19 +08:00
|
|
|
|
2018-09-30 00:58:55 +08:00
|
|
|
~~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~~
|
2017-02-08 05:12:19 +08:00
|
|
|
|
2017-08-11 01:55:27 +08:00
|
|
|
For more information in the source, here are some pointers:
|
2017-02-08 05:12:19 +08:00
|
|
|
|
2018-02-14 00:20:03 +08:00
|
|
|
- [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
|
2017-02-08 05:12:19 +08:00
|
|
|
|
2017-07-20 20:20:43 +08:00
|
|
|
## Joining
|
2017-02-08 05:12:19 +08:00
|
|
|
|
2017-07-20 20:20:43 +08:00
|
|
|
Developers welcome!
|
2017-02-08 05:12:19 +08:00
|
|
|
|
2017-07-20 20:20:43 +08:00
|
|
|
* Our developer mailing list:
|
|
|
|
|
http://lists.runtime.co/mailman/listinfo/dev-mcuboot_lists.runtime.co
|
2017-07-24 18:59:26 +08:00
|
|
|
* Our Slack channel: https://mcuboot.slack.com/ <br />
|
|
|
|
|
Get your invite [here!](https://join.slack.com/t/mcuboot/shared_invite/MjE2NDcwMTQ2MTYyLTE1MDA4MTIzNTAtYzgyZTU0NjFkMg)
|
2017-07-20 20:20:43 +08:00
|
|
|
* Our IRC channel: http://irc.freenode.net, #mcuboot
|
