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 <david.brown@linaro.org>
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 25f80c2..0000000
--- 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 8696495..0000000
--- 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 17852ed..0000000
--- 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 767aaad..0000000
--- 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 48a70f2..0000000
--- 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 121c885..0000000
--- 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 1302be3..0000000
--- 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 1613876..0000000
--- 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 414a7c9..0000000
--- 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 468edd6..0000000
--- 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 81e97e3..0000000
--- 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 07a5d92..0000000
--- 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 439e03f..0000000
--- 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 6f191df..0000000
--- 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 ec6c790..0000000
--- 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 0cc7483..0000000
--- 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 fceb9f5..0000000
--- 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 71a09f7..0000000
--- 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 f60e18f..0000000
--- 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 00bb626..2fc96f7 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 <jamie.mccrae@nordicsemi.no>
+ 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...