OrgZephyr/mcuboot
OrgZephyr
/
mcuboot
mirror of https://github.com/zephyrproject-rtos/mcuboot.git
1
0
Fork 0
Code Issues Releases Wiki Activity
mcuboot/docs/index.md

83 lines
3.6 KiB
Markdown
Raw Normal View History

Rearrange docs for gh-pages Github pages allows the documentation to be in the master branch in a 'docs' directory to be rendered as the main site (mcuboot.com). Rename this directory, and pull in the documentation files from the old gh-pages branch. The main index.md page does not link to the rest of the docs yet, and that change can be made in a future patch. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:04:34 +08:00
# MCUboot
## Overview
Minor doc cleanups Fix spelling of MCUboot, and remove a duplicated link. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-13 01:37:29 +08:00
MCUboot is a secure bootloader for 32-bit MCUs. The goal of MCUboot is to
Remove eol whitespace from doc file Remove these extraneous end of line spaces. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:06:38 +08:00
define a common infrastructure for the bootloader, system flash layout on
microcontroller systems, and to provide a secure bootloader that enables
Rearrange docs for gh-pages Github pages allows the documentation to be in the master branch in a 'docs' directory to be rendered as the main site (mcuboot.com). Rename this directory, and pull in the documentation files from the old gh-pages branch. The main index.md page does not link to the rest of the docs yet, and that change can be made in a future patch. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:04:34 +08:00
easy software upgrade.
Add deprecated warning to Jira and Confluence links This will fix #336 by adding deprecation warning to Jira and Confluence links as these are not used by the project anymore. Signed-off-by: Sigvart M. Hovland <sigvart.m@gmail.com>
2018-09-30 00:58:55 +08:00
MCUboot is operating system and hardware independent and relies on
Rearrange docs for gh-pages Github pages allows the documentation to be in the master branch in a 'docs' directory to be rendered as the main site (mcuboot.com). Rename this directory, and pull in the documentation files from the old gh-pages branch. The main index.md page does not link to the rest of the docs yet, and that change can be made in a future patch. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:04:34 +08:00
hardware porting layers from the operating system it works with. Currently
MCUboot works with both the Apache Mynewt, and Zephyr operating systems, but
more ports are planned in the future. RIOT is currently supported as a boot
target with a complete port planned.
docs: Add links to wikipage on project Update the main webpage to contain links to the wiki page docs on the project charter, and the membership page. Signed-off-by: David Brown <david.brown@linaro.org>
2021-04-02 04:39:23 +08:00
MCUboot is an open governance project. See the [membership
list](https://github.com/mcu-tools/mcuboot/wiki/Members) for current
members, and the
[charter](https://github.com/mcu-tools/mcuboot/wiki/MCUboot-Project-Charter)
for more details.
Make docs more visible from home page Add links to the other documents to the homepage at `index.md`. Clean up some of these other documents (including converting the Zephyr test plan to markdown). Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 04:47:48 +08:00
## Contents
docs: add link to encrypted_images.md and cleanup Add a link to the topic about encrypted images to the start page. Clean up the existing links to make the table of contents more consistent. Signed-off-by: Ruth Fuchss <ruth.fuchss@nordicsemi.no>
2019-11-01 23:32:20 +08:00
- General - this document
Change all doc links to use relative names Github pages assumes that links to files using relative names point to the same location so this should work both when accessing through the github browser and mcuboot.com Signed-off-by: Fabio Utzig <utzig@apache.org>
2018-02-13 01:31:32 +08:00
- [Release notes](release-notes.md)
docs: add link to encrypted_images.md and cleanup Add a link to the topic about encrypted images to the start page. Clean up the existing links to make the table of contents more consistent. Signed-off-by: Ruth Fuchss <ruth.fuchss@nordicsemi.no>
2019-11-01 23:32:20 +08:00
- [Bootloader design](design.md)
- [Encrypted images](encrypted_images.md)
- [imgtool](imgtool.md) - image signing and key management
docs: Write up some docs about ecdsa padding Start with some documentation on ECDSA signatures, and the problems with the current padding approach. Present a plan to support correctly formatted ECDSA signatures, and how to handle the transition both in the C code, as well as the tooling that signs images. Signed-off-by: David Brown <david.brown@linaro.org>
2019-12-13 07:19:55 +08:00
- [ecdsa](ecdsa.md) - Information about ECDSA signature formats
docs: Link to instructions from landing pages Link to usage instructions from the main README file and from docs/index.md so that the usage is visible from the root documentation files. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-01-23 22:43:46 +08:00
- Usage instructions:
Change all doc links to use relative names Github pages assumes that links to files using relative names point to the same location so this should work both when accessing through the github browser and mcuboot.com Signed-off-by: Fabio Utzig <utzig@apache.org>
2018-02-13 01:31:32 +08:00
- [Zephyr](readme-zephyr.md)
- [Mynewt](readme-mynewt.md)
- [RIOT](readme-riot.md)
Mbed-OS porting layer implementation for mcuboot This PR provides a porting layer implementation and framework for building an mcuboot-based bootloader with Mbed-OS. Some symbols are not provided by the Mbed-OS port within mcuboot, namely: - The secondary storage device (see below) - The signing keys - The encryption keys, if used Use of this port is demonstrated by the following projects: - https://github.com/AGlass0fMilk/mbed-mcuboot-demo (a complete mcuboot/Mbed-OS-based bootloader) - https://github.com/AGlass0fMilk/mbed-mcuboot-blinky (example showing how to make an Mbed-OS application that is bootable by mcuboot) Memory porting implementation: The underlying implemenation uses Mbed's BlockDevice API as the storage backend for mcuboot's memory operations. This provides a very flexible way of configuring the location and layout of the secondary flash storage area. To build an mcuboot-based bootloader with Mbed-OS, the user must implement a hook function, mbed::BlockDevice* get_secondary_bd(), to provide the secondary BlockDevice that mcuboot will use. The signing and encryption keys must also be provided by the user. They can be generated using the existing imgtool utility in the same manner used by Zephyr. There are no automated build steps currently provided by Mbed-OS to sign/encrypt build artifacts. Known limitations: The update candidate encryption features have not yet been fully tested. A truly secure implementation will require integration with Mbed's TRNG API in the future to inhibit side-channel attacks on the decryption process. The TinyCrypt backend is currently only supported for Mbed-OS builds when building with the GCC toolchain. The new cmake-based Mbed-OS build system will fix the underlying issue (file name uniqueness). Signed-off-by: George Beckstein <becksteing@embeddedplanet.com> Signed-off-by: Evelyne Donnaes <evelyne.donnaes@arm.com> Signed-off-by: Lingkai Dong <lingkai.dong@arm.com> Co-authored-by: Lingkai Dong <lingkai.dong@arm.com> Co-authored-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
2020-10-30 05:32:11 +08:00
- [Mbed-OS](readme-mbed.md)
docs: add link to encrypted_images.md and cleanup Add a link to the topic about encrypted images to the start page. Clean up the existing links to make the table of contents more consistent. Signed-off-by: Ruth Fuchss <ruth.fuchss@nordicsemi.no>
2019-11-01 23:32:20 +08:00
- [Patch submission](SubmittingPatches.md) - information
on how to contribute to mcuboot
Make docs more visible from home page Add links to the other documents to the homepage at `index.md`. Clean up some of these other documents (including converting the Zephyr test plan to markdown). Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 04:47:48 +08:00
- Testing
docs: add link to encrypted_images.md and cleanup Add a link to the topic about encrypted images to the start page. Clean up the existing links to make the table of contents more consistent. Signed-off-by: Ruth Fuchss <ruth.fuchss@nordicsemi.no>
2019-11-01 23:32:20 +08:00
- [Zephyr](testplan-zephyr.md) test plan
- [mynewt](testplan-mynewt.md) test plan
- [Release process](release.md)
Make docs more visible from home page Add links to the other documents to the homepage at `index.md`. Clean up some of these other documents (including converting the Zephyr test plan to markdown). Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 04:47:48 +08:00
Change all doc links to use relative names Github pages assumes that links to files using relative names point to the same location so this should work both when accessing through the github browser and mcuboot.com Signed-off-by: Fabio Utzig <utzig@apache.org>
2018-02-13 01:31:32 +08:00
There is also a document about [signed images](signed_images.md) that is out
of date. You should use `imgtool.py` instead of these documents.
Make docs more visible from home page Add links to the other documents to the homepage at `index.md`. Clean up some of these other documents (including converting the Zephyr test plan to markdown). Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 04:47:48 +08:00
Rearrange docs for gh-pages Github pages allows the documentation to be in the master branch in a 'docs' directory to be rendered as the main site (mcuboot.com). Rename this directory, and pull in the documentation files from the old gh-pages branch. The main index.md page does not link to the rest of the docs yet, and that change can be made in a future patch. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:04:34 +08:00
## Roadmap
Add deprecated warning to Jira and Confluence links This will fix #336 by adding deprecation warning to Jira and Confluence links as these are not used by the project anymore. Signed-off-by: Sigvart M. Hovland <sigvart.m@gmail.com>
2018-09-30 00:58:55 +08:00
The issues being planned and worked on are tracked using GitHub issues. To participate
Remove eol whitespace from doc file Remove these extraneous end of line spaces. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:06:38 +08:00
please visit:
Rearrange docs for gh-pages Github pages allows the documentation to be in the master branch in a 'docs' directory to be rendered as the main site (mcuboot.com). Rename this directory, and pull in the documentation files from the old gh-pages branch. The main index.md page does not link to the rest of the docs yet, and that change can be made in a future patch. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:04:34 +08:00
doc: fix github urls to use the new org Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
2020-11-10 23:35:04 +08:00
[MCUboot Issues](https://github.com/mcu-tools/mcuboot/issues)
Add deprecated warning to Jira and Confluence links This will fix #336 by adding deprecation warning to Jira and Confluence links as these are not used by the project anymore. Signed-off-by: Sigvart M. Hovland <sigvart.m@gmail.com>
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.~~
Rearrange docs for gh-pages Github pages allows the documentation to be in the master branch in a 'docs' directory to be rendered as the main site (mcuboot.com). Rename this directory, and pull in the documentation files from the old gh-pages branch. The main index.md page does not link to the rest of the docs yet, and that change can be made in a future patch. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:04:34 +08:00
Remove eol whitespace from doc file Remove these extraneous end of line spaces. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:06:38 +08:00
## Browsing
Rearrange docs for gh-pages Github pages allows the documentation to be in the master branch in a 'docs' directory to be rendered as the main site (mcuboot.com). Rename this directory, and pull in the documentation files from the old gh-pages branch. The main index.md page does not link to the rest of the docs yet, and that change can be made in a future patch. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:04:34 +08:00
Add deprecated warning to Jira and Confluence links This will fix #336 by adding deprecation warning to Jira and Confluence links as these are not used by the project anymore. Signed-off-by: Sigvart M. Hovland <sigvart.m@gmail.com>
2018-09-30 00:58:55 +08:00
Information and documentation on the bootloader is stored within the source.
Rearrange docs for gh-pages Github pages allows the documentation to be in the master branch in a 'docs' directory to be rendered as the main site (mcuboot.com). Rename this directory, and pull in the documentation files from the old gh-pages branch. The main index.md page does not link to the rest of the docs yet, and that change can be made in a future patch. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:04:34 +08:00
Add deprecated warning to Jira and Confluence links This will fix #336 by adding deprecation warning to Jira and Confluence links as these are not used by the project anymore. Signed-off-by: Sigvart M. Hovland <sigvart.m@gmail.com>
2018-09-30 00:58:55 +08:00
~~It was previously also documented on confluence: [Confluence page](https://runtimeco.atlassian.net/wiki/discover/all-updates)
, but it is now deprecated and not currently maintained~~
Rearrange docs for gh-pages Github pages allows the documentation to be in the master branch in a 'docs' directory to be rendered as the main site (mcuboot.com). Rename this directory, and pull in the documentation files from the old gh-pages branch. The main index.md page does not link to the rest of the docs yet, and that change can be made in a future patch. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:04:34 +08:00
Remove eol whitespace from doc file Remove these extraneous end of line spaces. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:06:38 +08:00
For more information in the source, here are some pointers:
Rearrange docs for gh-pages Github pages allows the documentation to be in the master branch in a 'docs' directory to be rendered as the main site (mcuboot.com). Rename this directory, and pull in the documentation files from the old gh-pages branch. The main index.md page does not link to the rest of the docs yet, and that change can be made in a future patch. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:04:34 +08:00
Migrate master->main Change references in CI and docs from 'master' to 'main' as the primary branch has been renamed. Signed-off-by: David Brown <david.brown@linaro.org>
2021-05-15 00:12:10 +08:00
- [boot/bootutil](https://github.com/mcu-tools/mcuboot/tree/main/boot/bootutil): The core of the bootloader itself.
- [boot/boot\_serial](https://github.com/mcu-tools/mcuboot/tree/main/boot/boot_serial): Support for serial upgrade within the bootloader itself.
- [boot/zephyr](https://github.com/mcu-tools/mcuboot/tree/main/boot/zephyr): Port of the bootloader to Zephyr
- [boot/mynewt](https://github.com/mcu-tools/mcuboot/tree/main/boot/mynewt): Mynewt bootloader app
- [boot/mbed](https://github.com/mcu-tools/mcuboot/tree/main/boot/mbed): Port of the bootloader to Mbed-OS
- [imgtool](https://github.com/mcu-tools/mcuboot/tree/main/scripts/imgtool.py): A tool to securely sign firmware images for booting by MCUboot.
- [sim](https://github.com/mcu-tools/mcuboot/tree/main/sim): A bootloader simulator for testing and regression
Rearrange docs for gh-pages Github pages allows the documentation to be in the master branch in a 'docs' directory to be rendered as the main site (mcuboot.com). Rename this directory, and pull in the documentation files from the old gh-pages branch. The main index.md page does not link to the rest of the docs yet, and that change can be made in a future patch. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:04:34 +08:00
## Joining
Developers welcome!
docs: fix mailing list URL Signed-off-by: Fabio Utzig <utzig@apache.org>
2020-01-22 23:26:04 +08:00
* [Our developer mailing list](https://groups.io/g/MCUBoot)
Rearrange docs for gh-pages Github pages allows the documentation to be in the master branch in a 'docs' directory to be rendered as the main site (mcuboot.com). Rename this directory, and pull in the documentation files from the old gh-pages branch. The main index.md page does not link to the rest of the docs yet, and that change can be made in a future patch. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:04:34 +08:00
* [Our Slack channel](https://mcuboot.slack.com/)<br />
Get your invite [here!](https://join.slack.com/t/mcuboot/shared_invite/MjE2NDcwMTQ2MTYyLTE1MDA4MTIzNTAtYzgyZTU0NjFkMg)
* [Our IRC channel](http://irc.freenode.net), channel #mcuboot ([IRC
link](irc://chat.freenode.net/#mcuboot)
docs: Add links to wikipage on project Update the main webpage to contain links to the wiki page docs on the project charter, and the membership page. Signed-off-by: David Brown <david.brown@linaro.org>
2021-04-02 04:39:23 +08:00
* [Current members](https://github.com/mcu-tools/mcuboot/wiki/Members)
* [Project charter](https://github.com/mcu-tools/mcuboot/wiki/MCUboot-Project-Charter)