tinycrypt: deprecate the library

Since we now have PSA Crypto APIs/Mbed TLS alternatives for crypto operations in all Zephyr's codebase we can start the deprecation of the TinyCrypt libary (as planned from #43712). This commit is only the inital step: updates documentation and add the DEPRECATED Kconfig option to the TINYCRYPT one. Signed-off-by: Valerio Setti <[email protected]>
zephyrproject-rtos · Oct 17, 2024 · 5e225e0 · 5e225e0
1 parent cbb3229
commit 5e225e0
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 0 deletions.
diff --git a/doc/releases/migration-guide-4.0.rst b/doc/releases/migration-guide-4.0.rst
@@ -75,6 +75,19 @@ Mbed TLS
   corresponding build symbol was removed in Mbed TLS 3.1.0 and is now assumed to
   be enabled. (:github:`77657`)
 
+TinyCrypt
+=========
+
+* Starting from this release the library is marked as deprecated (:github:`79566`).
+  The reasons for this are (:github:`43712``):
+
+  * the upstream version of this library is unmaintained.
+
+  * to reduce the number of crypto libraries available in Zephyr (currently there are
+    3 different implementations: TinyCrypt, MbedTLS and PSA Crypto APIs).
+
+  The PSA Crypto API is now the de-facto standard to perform crypto operations.
+
 Trusted Firmware-M
 ==================
 

diff --git a/doc/releases/release-notes-4.0.rst b/doc/releases/release-notes-4.0.rst
@@ -56,6 +56,16 @@ Deprecated in this release
 
 * The :ref:`kscan_api` subsystem has been marked as deprecated.
 
+* The TinyCrypt library was marked as deprecated (:github:`79566`). The reasons
+  for this are (:github:`43712``):
+
+  * the upstream version of this library is unmaintained.
+
+  * to reduce the number of crypto libraries available in Zephyr (currently there are
+    3 different implementations: TinyCrypt, MbedTLS and PSA Crypto APIs).
+
+  The PSA Crypto API is now the de-facto standard to perform crypto operations.
+
 Architectures
 *************
 

diff --git a/modules/Kconfig.tinycrypt b/modules/Kconfig.tinycrypt
@@ -9,6 +9,7 @@ config ZEPHYR_TINYCRYPT_MODULE
 config TINYCRYPT
 	bool "TinyCrypt Support"
 	depends on ZEPHYR_TINYCRYPT_MODULE
+	select DEPRECATED
 	help
 	  This option enables the TinyCrypt cryptography library.