From 62e2b4dead3237f33aba9f6421c7730712a07e23 Mon Sep 17 00:00:00 2001 From: David Brown Date: Thu, 28 Sep 2023 11:39:14 -0600 Subject: [PATCH] docs: Update release notes for 2.0.0-rc1 Collect release notes, and add a bit about the API change. Signed-off-by: David Brown --- docs/release-notes.d/boot-open-failure.md | 2 - docs/release-notes.d/bs-encrypted-list.md | 4 -- docs/release-notes.d/cddl-change.md | 2 - docs/release-notes.d/data-sharing.md | 2 - docs/release-notes.d/ecdsa-tlv-p384.md | 2 - docs/release-notes.d/espressif-hal-updates.md | 3 - docs/release-notes.d/img-state.md | 1 - docs/release-notes.d/imgtool-getpub-hash.md | 1 - .../imgtool-getpub-output-file.md | 1 - docs/release-notes.d/imgtool-getpub-raw.md | 1 - docs/release-notes.d/imgtool_dumpinfo.md | 1 - docs/release-notes.d/p224-removal.md | 1 - docs/release-notes.d/serial-timeoout-fix.md | 4 -- docs/release-notes.d/zcbor-fix.md | 3 - docs/release-notes.d/zcbor-update.md | 1 - docs/release-notes.d/zephyr-bs-extensions.md | 3 - docs/release-notes.d/zephyr-data-sharing.md | 2 - docs/release-notes.d/zephyr-debug.md | 2 - docs/release-notes.d/zephyr-encryption.md | 9 --- docs/release-notes.md | 62 +++++++++++++++++++ 20 files changed, 62 insertions(+), 45 deletions(-) delete mode 100644 docs/release-notes.d/boot-open-failure.md delete mode 100644 docs/release-notes.d/bs-encrypted-list.md delete mode 100644 docs/release-notes.d/cddl-change.md delete mode 100644 docs/release-notes.d/data-sharing.md delete mode 100644 docs/release-notes.d/ecdsa-tlv-p384.md delete mode 100644 docs/release-notes.d/espressif-hal-updates.md delete mode 100644 docs/release-notes.d/img-state.md delete mode 100644 docs/release-notes.d/imgtool-getpub-hash.md delete mode 100644 docs/release-notes.d/imgtool-getpub-output-file.md delete mode 100644 docs/release-notes.d/imgtool-getpub-raw.md delete mode 100644 docs/release-notes.d/imgtool_dumpinfo.md delete mode 100644 docs/release-notes.d/p224-removal.md delete mode 100644 docs/release-notes.d/serial-timeoout-fix.md delete mode 100644 docs/release-notes.d/zcbor-fix.md delete mode 100644 docs/release-notes.d/zcbor-update.md delete mode 100644 docs/release-notes.d/zephyr-bs-extensions.md delete mode 100644 docs/release-notes.d/zephyr-data-sharing.md delete mode 100644 docs/release-notes.d/zephyr-debug.md delete mode 100644 docs/release-notes.d/zephyr-encryption.md diff --git a/docs/release-notes.d/boot-open-failure.md b/docs/release-notes.d/boot-open-failure.md deleted file mode 100644 index 25f80c26..00000000 --- a/docs/release-notes.d/boot-open-failure.md +++ /dev/null @@ -1,2 +0,0 @@ -- Add error when flash device fails to open. -- Panic bootloader when flash device fails to open. diff --git a/docs/release-notes.d/bs-encrypted-list.md b/docs/release-notes.d/bs-encrypted-list.md deleted file mode 100644 index 86964958..00000000 --- a/docs/release-notes.d/bs-encrypted-list.md +++ /dev/null @@ -1,4 +0,0 @@ -- Fixed issue with serial recovery not showing image details for - decrypted images. -- Fixes issue with serial recovery in single slot mode wrongly - iterating over 2 image slots. diff --git a/docs/release-notes.d/cddl-change.md b/docs/release-notes.d/cddl-change.md deleted file mode 100644 index 17852eda..00000000 --- a/docs/release-notes.d/cddl-change.md +++ /dev/null @@ -1,2 +0,0 @@ -- CDDL auto-generated function code has been replaced with zcbor function - calls, this now allows the parameters to be supplied in any order. diff --git a/docs/release-notes.d/data-sharing.md b/docs/release-notes.d/data-sharing.md deleted file mode 100644 index 767aaada..00000000 --- a/docs/release-notes.d/data-sharing.md +++ /dev/null @@ -1,2 +0,0 @@ -- Added currently running slot ID and maximum application size to - shared data function definition. diff --git a/docs/release-notes.d/ecdsa-tlv-p384.md b/docs/release-notes.d/ecdsa-tlv-p384.md deleted file mode 100644 index 48a70f2c..00000000 --- a/docs/release-notes.d/ecdsa-tlv-p384.md +++ /dev/null @@ -1,2 +0,0 @@ -- Make the ECDSA256 TLV curve agnostic and rename it to ECDSA_SIG. -- imgtool: add P384 support along with SHA384. diff --git a/docs/release-notes.d/espressif-hal-updates.md b/docs/release-notes.d/espressif-hal-updates.md deleted file mode 100644 index 121c8853..00000000 --- a/docs/release-notes.d/espressif-hal-updates.md +++ /dev/null @@ -1,3 +0,0 @@ -- espressif: refactor after removing IDF submodule -- espressif: add ESP32-C6, ESP32-C2 and ESP32-H2 new chips support -- espressif: adjustments after IDF v5.1 compatibility, secure boot build and memory map organization diff --git a/docs/release-notes.d/img-state.md b/docs/release-notes.d/img-state.md deleted file mode 100644 index 1302be36..00000000 --- a/docs/release-notes.d/img-state.md +++ /dev/null @@ -1 +0,0 @@ -- Serial recovery image state and image set state optional commands added diff --git a/docs/release-notes.d/imgtool-getpub-hash.md b/docs/release-notes.d/imgtool-getpub-hash.md deleted file mode 100644 index 1613876a..00000000 --- a/docs/release-notes.d/imgtool-getpub-hash.md +++ /dev/null @@ -1 +0,0 @@ -- imgtool: add 'getpubhash' command to dump the sha256 hash of the public key diff --git a/docs/release-notes.d/imgtool-getpub-output-file.md b/docs/release-notes.d/imgtool-getpub-output-file.md deleted file mode 100644 index 414a7c93..00000000 --- a/docs/release-notes.d/imgtool-getpub-output-file.md +++ /dev/null @@ -1 +0,0 @@ -- imgtool's getpub can print the output to a file diff --git a/docs/release-notes.d/imgtool-getpub-raw.md b/docs/release-notes.d/imgtool-getpub-raw.md deleted file mode 100644 index 468edd6c..00000000 --- a/docs/release-notes.d/imgtool-getpub-raw.md +++ /dev/null @@ -1 +0,0 @@ -- imgtool can dump the raw versions of the public keys diff --git a/docs/release-notes.d/imgtool_dumpinfo.md b/docs/release-notes.d/imgtool_dumpinfo.md deleted file mode 100644 index 81e97e32..00000000 --- a/docs/release-notes.d/imgtool_dumpinfo.md +++ /dev/null @@ -1 +0,0 @@ -- imgtool: add 'dumpinfo' command for signed image parsing. diff --git a/docs/release-notes.d/p224-removal.md b/docs/release-notes.d/p224-removal.md deleted file mode 100644 index 07a5d92d..00000000 --- a/docs/release-notes.d/p224-removal.md +++ /dev/null @@ -1 +0,0 @@ -- Drop ECDSA P224 support diff --git a/docs/release-notes.d/serial-timeoout-fix.md b/docs/release-notes.d/serial-timeoout-fix.md deleted file mode 100644 index 439e03fc..00000000 --- a/docs/release-notes.d/serial-timeoout-fix.md +++ /dev/null @@ -1,4 +0,0 @@ -- Fixed an issue with boot_serial repeats not being processed when - output was sent, this would lead to a divergence of commands - whereby later commands being sent would have the previous command - output sent instead. diff --git a/docs/release-notes.d/zcbor-fix.md b/docs/release-notes.d/zcbor-fix.md deleted file mode 100644 index 6f191df9..00000000 --- a/docs/release-notes.d/zcbor-fix.md +++ /dev/null @@ -1,3 +0,0 @@ -- Fixed an issue with the boot_serial zcbor setup encoder function - wrongly including the buffer address in the size which caused - serial recovery to fail on some platforms. diff --git a/docs/release-notes.d/zcbor-update.md b/docs/release-notes.d/zcbor-update.md deleted file mode 100644 index ec6c7908..00000000 --- a/docs/release-notes.d/zcbor-update.md +++ /dev/null @@ -1 +0,0 @@ -- zcbor library files have been updated to version 0.7.0 diff --git a/docs/release-notes.d/zephyr-bs-extensions.md b/docs/release-notes.d/zephyr-bs-extensions.md deleted file mode 100644 index 0cc74836..00000000 --- a/docs/release-notes.d/zephyr-bs-extensions.md +++ /dev/null @@ -1,3 +0,0 @@ -- Reworked boot serial extensions so that they can be used by modules - or from user repositories by switching to iterable sections. -- Removed Zephyr custom img list boot serial extension support. diff --git a/docs/release-notes.d/zephyr-data-sharing.md b/docs/release-notes.d/zephyr-data-sharing.md deleted file mode 100644 index fceb9f53..00000000 --- a/docs/release-notes.d/zephyr-data-sharing.md +++ /dev/null @@ -1,2 +0,0 @@ -- (Zephyr) Adds support for sharing boot information with - application via retention subsystem diff --git a/docs/release-notes.d/zephyr-debug.md b/docs/release-notes.d/zephyr-debug.md deleted file mode 100644 index 71a09f75..00000000 --- a/docs/release-notes.d/zephyr-debug.md +++ /dev/null @@ -1,2 +0,0 @@ -- Zephyr no longer builds in optimize for debug mode, this saves a - significant amount of flash space. diff --git a/docs/release-notes.d/zephyr-encryption.md b/docs/release-notes.d/zephyr-encryption.md deleted file mode 100644 index f60e18f8..00000000 --- a/docs/release-notes.d/zephyr-encryption.md +++ /dev/null @@ -1,9 +0,0 @@ -- Reworked image encryption support for Zephyr, static dummy key files - are no longer in the code, a pem file must be supplied to extract - the private and public keys. The Kconfig menu has changed to only - show a single option for enabling encryption and selecting the key - file. -- Serial recovery can now read and handle encrypted seondary slot - partitions. -- Serial recovery with MBEDTLS no longer has undefined operations which - led to usage faults when the secondary slot image was encrypted. diff --git a/docs/release-notes.md b/docs/release-notes.md index 00bb6261..2fc96f74 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -3,6 +3,68 @@ - Table of Contents {:toc} +## Version 2.0.0 + +Note that this release, 2.0.0 is a new major number, and contains a small API +change in the interface between mcuboot and the platform. All platforms +contained within the MCUboot tree have been updated, but any external platforms +will have to be adjusted. The following commit makes the API change, in the +function `boot_save_shared_data`. + + commit 3016d00cd765e7c09a14af55fb4dcad945e4b982 + Author: Jamie McCrae + Date: Tue Mar 14 12:35:51 2023 +0000 + + bootutil: Add active slot number and max app size to shared data + +### About this release + +- Add error when flash device fails to open. +- Panic bootloader when flash device fails to open. +- Fixed issue with serial recovery not showing image details for + decrypted images. +- Fixes issue with serial recovery in single slot mode wrongly + iterating over 2 image slots. +- CDDL auto-generated function code has been replaced with zcbor function + calls, this now allows the parameters to be supplied in any order. +- Added currently running slot ID and maximum application size to + shared data function definition. +- Make the ECDSA256 TLV curve agnostic and rename it to ECDSA_SIG. +- imgtool: add P384 support along with SHA384. +- espressif: refactor after removing IDF submodule +- espressif: add ESP32-C6, ESP32-C2 and ESP32-H2 new chips support +- espressif: adjustments after IDF v5.1 compatibility, secure boot build and memory map organization +- Serial recovery image state and image set state optional commands added +- imgtool: add 'dumpinfo' command for signed image parsing. +- imgtool: add 'getpubhash' command to dump the sha256 hash of the public key +- imgtool's getpub can print the output to a file +- imgtool can dump the raw versions of the public keys +- Drop ECDSA P224 support +- Fixed an issue with boot_serial repeats not being processed when + output was sent, this would lead to a divergence of commands + whereby later commands being sent would have the previous command + output sent instead. +- Fixed an issue with the boot_serial zcbor setup encoder function + wrongly including the buffer address in the size which caused + serial recovery to fail on some platforms. +- zcbor library files have been updated to version 0.7.0 +- Reworked boot serial extensions so that they can be used by modules + or from user repositories by switching to iterable sections. +- Removed Zephyr custom img list boot serial extension support. +- (Zephyr) Adds support for sharing boot information with + application via retention subsystem +- Zephyr no longer builds in optimize for debug mode, this saves a + significant amount of flash space. +- Reworked image encryption support for Zephyr, static dummy key files + are no longer in the code, a pem file must be supplied to extract + the private and public keys. The Kconfig menu has changed to only + show a single option for enabling encryption and selecting the key + file. +- Serial recovery can now read and handle encrypted seondary slot + partitions. +- Serial recovery with MBEDTLS no longer has undefined operations which + led to usage faults when the secondary slot image was encrypted. + ## Version 1.10.0 The 1.10.0 release of MCUboot contains...