From dd3b539573f8033a6dad97c6839c5416d1be15a0 Mon Sep 17 00:00:00 2001 From: Ronald Cron Date: Thu, 1 Apr 2021 15:36:50 +0200 Subject: [PATCH] psa: include: Clarify scope of crypto_builtin/driver_contexts.h Signed-off-by: Ronald Cron --- include/psa/crypto_builtin.h | 13 +++++++++++-- include/psa/crypto_driver_contexts.h | 9 +++++++++ 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/include/psa/crypto_builtin.h b/include/psa/crypto_builtin.h index 7b661728d..b3bc1408c 100644 --- a/include/psa/crypto_builtin.h +++ b/include/psa/crypto_builtin.h @@ -1,6 +1,15 @@ /* - * Context structure declaration of the software-based drivers called - * through the PSA Crypto driver dispatch layer. + * Context structure declaration of the Mbed TLS software-based PSA drivers + * called through the PSA Crypto driver dispatch layer. + * + * \note This file may not be included directly. Applications must + * include psa/crypto.h. + * + * \note This header and its content is not part of the Mbed TLS API and + * applications must not depend on it. Its main purpose is to define the + * multi-part state objects of the Mbed TLS software-based PSA drivers. The + * definition of these objects are then used by crypto_struct.h to define the + * implementation-defined types of PSA multi-part state objects. */ /* * Copyright The Mbed TLS Contributors diff --git a/include/psa/crypto_driver_contexts.h b/include/psa/crypto_driver_contexts.h index 869769f22..d725e8440 100644 --- a/include/psa/crypto_driver_contexts.h +++ b/include/psa/crypto_driver_contexts.h @@ -3,6 +3,15 @@ * interface. * * Warning: This file will be auto-generated in the future. + * + * \note This file may not be included directly. Applications must + * include psa/crypto.h. + * + * \note This header and its content is not part of the Mbed TLS API and + * applications must not depend on it. Its main purpose is to define the + * multi-part state objects of the PSA drivers included in the cryptographic + * library. The definition of these objects are then used by crypto_struct.h + * to define the implementation-defined types of PSA multi-part state objects. */ /* Copyright The Mbed TLS Contributors * SPDX-License-Identifier: Apache-2.0