release-note: flash_api_write_protection() deprecation record

Added note on deprecation of the API and description of flash drivers changes. Signed-off-by: Andrzej Puzdrowski <[email protected]>
albayenes · Mar 29, 2021 · 4edce6b · 4edce6b
1 parent f3109a7
commit 4edce6b
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/doc/releases/release-notes-2.6.rst b/doc/releases/release-notes-2.6.rst
@@ -80,6 +80,8 @@ Deprecated in this release
   Disk API header ``<include/disk/disk_access.h>`` is deprecated in favor of
   ``<include/storage/disk_access.h>``.
 
+* :c:func:`flash_write_protection_set()`.
+
 ==========================
 
 Removed APIs in this release
@@ -188,6 +190,18 @@ Drivers and Sensors
 
 * Flash
 
+  * flash_write_protection_set() has been deprecated and will be removed in
+    Zephyr 2.8. Responsibility for write/erase protection management has been
+    moved to the driver-specific implementation of the flash_write() and
+    flash_erase() API calls. All in-tree flash drivers have been updated,
+    and the protect implementation removed from their API tables.
+    During the deprecation period user code invoking
+    flash_write_protection_set() will have no effect, but the flash_write() and
+    flash_erase() driver shims will wrap their calls with calls to the protect
+    implementation if it is present in the API table.
+    Out-of-tree drivers must be updated before the wrapping in the shims is
+    removed when the deprecation period ends.
+
 * GPIO
 
 * Hardware Info