| ccollins476ad | fc6199e | 2016-12-12 17:53:39 -0600 | [diff] [blame] | 1 | # mcuboot |
| Sterling Hughes | b6903ec | 2017-02-07 13:12:19 -0800 | [diff] [blame] | 2 | |
| 3 | ## Overview |
| 4 | |
| 5 | MCUBoot is a secure bootloader for 32-bit MCUs. The goal of MCUBoot is to |
| 6 | define a common infrastructure for the bootloader, system flash layout on |
| 7 | microcontroller systems, and to provide a secure bootloader that enables |
| 8 | easy software upgrade. |
| 9 | |
| 10 | MCUboot is operating system and hardware independent, and relies on |
| 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 |
| Fabio Utzig | 097f76b | 2017-07-20 08:59:51 -0300 | [diff] [blame] | 13 | more ports are planned in the future. RIOT is currently supported as a boot |
| 14 | target with complete port arriving in the near future. |
| Sterling Hughes | b6903ec | 2017-02-07 13:12:19 -0800 | [diff] [blame] | 15 | |
| 16 | ## Roadmap |
| 17 | |
| Fabio Utzig | 097f76b | 2017-07-20 08:59:51 -0300 | [diff] [blame] | 18 | The issues being planned and worked on are tracked on Jira. To participate |
| 19 | please visit: |
| Sterling Hughes | b6903ec | 2017-02-07 13:12:19 -0800 | [diff] [blame] | 20 | |
| 21 | https://runtimeco.atlassian.net/projects/MCUB/summary |
| 22 | |
| 23 | ## Browsing |
| 24 | |
| 25 | Information and documentation on the bootloader is stored within the source, and on confluence: |
| 26 | |
| 27 | https://runtimeco.atlassian.net/wiki/discover/all-updates |
| 28 | |
| 29 | For more information in the source, here are some pointers: |
| 30 | |
| Sterling Hughes | 500705e | 2017-02-07 13:28:09 -0800 | [diff] [blame] | 31 | - [boot/bootutil](https://github.com/runtimeco/mcuboot/tree/master/boot/bootutil): The core of the bootloader itself. |
| 32 | - [boot/boot\_serial](https://github.com/runtimeco/mcuboot/tree/master/boot/boot_serial): Support for serial upgrade within the bootloader itself. |
| 33 | - [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] | 34 | - [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] | 35 | - [imgtool](https://github.com/runtimeco/mcuboot/tree/master/imgtool): A tool to securely sign firmware images for booting by mcuboot. |
| 36 | - [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] | 37 | |
| Fabio Utzig | 7402374 | 2017-07-20 09:20:43 -0300 | [diff] [blame^] | 38 | ## Joining |
| Sterling Hughes | b6903ec | 2017-02-07 13:12:19 -0800 | [diff] [blame] | 39 | |
| Fabio Utzig | 7402374 | 2017-07-20 09:20:43 -0300 | [diff] [blame^] | 40 | Developers welcome! |
| Sterling Hughes | b6903ec | 2017-02-07 13:12:19 -0800 | [diff] [blame] | 41 | |
| Fabio Utzig | 7402374 | 2017-07-20 09:20:43 -0300 | [diff] [blame^] | 42 | * Our developer mailing list: |
| 43 | http://lists.runtime.co/mailman/listinfo/dev-mcuboot_lists.runtime.co |
| 44 | * Our IRC channel: http://irc.freenode.net, #mcuboot |