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