| Fabio Utzig | 811205e | 2017-08-10 14:55:27 -0300 | [diff] [blame] | 1 | # [mcuboot](http://mcuboot.com/) |
| 2 | |
| 3 | [][coverity] |
| 4 | [][travis] |
| 5 | |
| 6 | [coverity]: https://scan.coverity.com/projects/mcuboot |
| 7 | [travis]: https://travis-ci.org/runtimeco/mcuboot |
| Sterling Hughes | b6903ec | 2017-02-07 13:12:19 -0800 | [diff] [blame] | 8 | |
| Fabio Utzig | 476fd99 | 2018-01-09 16:36:18 -0200 | [diff] [blame] | 9 | This is mcuboot, version 1.1.0 |
| David Brown | a3be264 | 2017-07-26 19:02:33 -0600 | [diff] [blame] | 10 | |
| Fabio Utzig | 811205e | 2017-08-10 14:55:27 -0300 | [diff] [blame] | 11 | MCUBoot is a secure bootloader for 32-bit MCUs. The goal of MCUBoot is to |
| 12 | define a common infrastructure for the bootloader, system flash layout on |
| 13 | microcontroller systems, and to provide a secure bootloader that enables |
| Sterling Hughes | b6903ec | 2017-02-07 13:12:19 -0800 | [diff] [blame] | 14 | easy software upgrade. |
| 15 | |
| Fabio Utzig | 811205e | 2017-08-10 14:55:27 -0300 | [diff] [blame] | 16 | MCUboot is operating system and hardware independent, and relies on |
| Sterling Hughes | b6903ec | 2017-02-07 13:12:19 -0800 | [diff] [blame] | 17 | hardware porting layers from the operating system it works with. Currently |
| 18 | mcuboot works with both the Apache Mynewt, and Zephyr operating systems, but |
| Fabio Utzig | 097f76b | 2017-07-20 08:59:51 -0300 | [diff] [blame] | 19 | more ports are planned in the future. RIOT is currently supported as a boot |
| Fabio Utzig | 756ca86 | 2017-07-20 13:38:22 -0300 | [diff] [blame] | 20 | target with a complete port planned. |
| Sterling Hughes | b6903ec | 2017-02-07 13:12:19 -0800 | [diff] [blame] | 21 | |
| Carles Cufi | 3b61e70 | 2018-01-23 15:43:46 +0100 | [diff] [blame^] | 22 | ## Using MCUboot |
| 23 | |
| 24 | Instructions 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) |
| 28 | |
| Sterling Hughes | b6903ec | 2017-02-07 13:12:19 -0800 | [diff] [blame] | 29 | ## Roadmap |
| 30 | |
| Fabio Utzig | 097f76b | 2017-07-20 08:59:51 -0300 | [diff] [blame] | 31 | The issues being planned and worked on are tracked on Jira. To participate |
| Fabio Utzig | 811205e | 2017-08-10 14:55:27 -0300 | [diff] [blame] | 32 | please visit: |
| Sterling Hughes | b6903ec | 2017-02-07 13:12:19 -0800 | [diff] [blame] | 33 | |
| 34 | https://runtimeco.atlassian.net/projects/MCUB/summary |
| 35 | |
| Fabio Utzig | 811205e | 2017-08-10 14:55:27 -0300 | [diff] [blame] | 36 | ## Browsing |
| Sterling Hughes | b6903ec | 2017-02-07 13:12:19 -0800 | [diff] [blame] | 37 | |
| 38 | Information and documentation on the bootloader is stored within the source, and on confluence: |
| 39 | |
| 40 | https://runtimeco.atlassian.net/wiki/discover/all-updates |
| 41 | |
| Fabio Utzig | 811205e | 2017-08-10 14:55:27 -0300 | [diff] [blame] | 42 | For more information in the source, here are some pointers: |
| Sterling Hughes | b6903ec | 2017-02-07 13:12:19 -0800 | [diff] [blame] | 43 | |
| Sterling Hughes | 500705e | 2017-02-07 13:28:09 -0800 | [diff] [blame] | 44 | - [boot/bootutil](https://github.com/runtimeco/mcuboot/tree/master/boot/bootutil): The core of the bootloader itself. |
| 45 | - [boot/boot\_serial](https://github.com/runtimeco/mcuboot/tree/master/boot/boot_serial): Support for serial upgrade within the bootloader itself. |
| 46 | - [boot/zephyr](https://github.com/runtimeco/mcuboot/tree/master/boot/zephyr): Port of the bootloader to Zephyr |
| Fabio Utzig | 097f76b | 2017-07-20 08:59:51 -0300 | [diff] [blame] | 47 | - [boot/mynewt](https://github.com/runtimeco/mcuboot/tree/master/boot/mynewt): Mynewt bootloader app |
| Sterling Hughes | 500705e | 2017-02-07 13:28:09 -0800 | [diff] [blame] | 48 | - [imgtool](https://github.com/runtimeco/mcuboot/tree/master/imgtool): A tool to securely sign firmware images for booting by mcuboot. |
| 49 | - [sim](https://github.com/runtimeco/mcuboot/tree/master/sim): A bootloader simulator for testing and regression |
| Sterling Hughes | b6903ec | 2017-02-07 13:12:19 -0800 | [diff] [blame] | 50 | |
| Fabio Utzig | 7402374 | 2017-07-20 09:20:43 -0300 | [diff] [blame] | 51 | ## Joining |
| Sterling Hughes | b6903ec | 2017-02-07 13:12:19 -0800 | [diff] [blame] | 52 | |
| Fabio Utzig | 7402374 | 2017-07-20 09:20:43 -0300 | [diff] [blame] | 53 | Developers welcome! |
| Sterling Hughes | b6903ec | 2017-02-07 13:12:19 -0800 | [diff] [blame] | 54 | |
| Fabio Utzig | 7402374 | 2017-07-20 09:20:43 -0300 | [diff] [blame] | 55 | * Our developer mailing list: |
| 56 | http://lists.runtime.co/mailman/listinfo/dev-mcuboot_lists.runtime.co |
| Fabio Utzig | 83e5929 | 2017-07-24 07:59:26 -0300 | [diff] [blame] | 57 | * Our Slack channel: https://mcuboot.slack.com/ <br /> |
| 58 | Get your invite [here!](https://join.slack.com/t/mcuboot/shared_invite/MjE2NDcwMTQ2MTYyLTE1MDA4MTIzNTAtYzgyZTU0NjFkMg) |
| Fabio Utzig | 7402374 | 2017-07-20 09:20:43 -0300 | [diff] [blame] | 59 | * Our IRC channel: http://irc.freenode.net, #mcuboot |