Add docs/use-psa-crypto.md

Signed-off-by: Manuel Pégourié-Gonnard <manuel.pegourie-gonnard@arm.com>
This commit is contained in:
Manuel Pégourié-Gonnard 2021-09-20 13:21:25 +02:00
parent 304689e4c4
commit 13b0bebf7d
2 changed files with 22 additions and 0 deletions

19
docs/use-psa-crypto.md Normal file
View file

@ -0,0 +1,19 @@
This document describes the compile-time configutation option
`MBEDTLS_USE_PSA_CRYPTO`: its current effects as well as some design
considerations and plans for the future.
Current effects
===============
(To be written.)
Parts that are not affected yet
===============================
(To be written.)
Design considerations
=====================
(To be written.)

View file

@ -1718,6 +1718,9 @@
* will still continue to work as usual, so enabling this option should not
* break backwards compatibility.
*
* \note See docs/use-psa-crypto.md for a complete description of what this
* option currently does, and of parts that are not affected by it so far.
*
* \warning The PSA Crypto API is in beta stage. While you're welcome to
* experiment using it, incompatible API changes are still possible, and some
* parts may not have reached the same quality as the rest of Mbed TLS yet.