yuzu/mbedtls
1
0
Fork 0
mirror of https://github.com/yuzu-emu/mbedtls.git synced 2025-02-24 20:46:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add notes about the purpose and usage of auxiliary header files

Browse source
This commit is contained in:
Gilles Peskine 2018-06-28 18:02:53 +02:00 committed by itayzafrir
parent 0b352bcf95
commit 07c91f5df3
4 changed files with 33 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
include/psa/crypto_extra.h
View file

@ -2,6 +2,11 @@
* \file psa/crypto_extra.h * \file psa/crypto_extra.h
* *
* \brief PSA cryptography module: Mbed TLS vendor extensions * \brief PSA cryptography module: Mbed TLS vendor extensions
*
* \note This file may not be included directly. Applications must
* include psa/crypto.h.
*
* This file is reserved for vendor-specific definitions.
*/ */
/* /*
* Copyright (C) 2018, ARM Limited, All Rights Reserved * Copyright (C) 2018, ARM Limited, All Rights Reserved

10
include/psa/crypto_platform.h
View file

@ -2,6 +2,16 @@
* \file psa/crypto_platform.h * \file psa/crypto_platform.h
* *
* \brief PSA cryptography module: Mbed TLS platfom definitions * \brief PSA cryptography module: Mbed TLS platfom definitions
*
* \note This file may not be included directly. Applications must
* include psa/crypto.h.
*
* This file contains platform-dependent type definitions.
*
* In implementations with isolation between the application and the
* cryptography module, implementers should take care to ensure that
* the definitions that are exposed to applications match what the
* module implements.
*/ */
/* /*
* Copyright (C) 2018, ARM Limited, All Rights Reserved * Copyright (C) 2018, ARM Limited, All Rights Reserved

8
include/psa/crypto_sizes.h
View file

@ -3,12 +3,20 @@
* *
* \brief PSA cryptography module: Mbed TLS buffer size macros * \brief PSA cryptography module: Mbed TLS buffer size macros
* *
* \note This file may not be included directly. Applications must
* include psa/crypto.h.
*
* This file contains the definitions of macros that are useful to * This file contains the definitions of macros that are useful to
* compute buffer sizes. The signatures and semantics of these macros * compute buffer sizes. The signatures and semantics of these macros
* are standardized, but the definitions are not, because they depend on * are standardized, but the definitions are not, because they depend on
* the available algorithms and, in some cases, on permitted tolerances * the available algorithms and, in some cases, on permitted tolerances
* on buffer sizes. * on buffer sizes.
* *
* In implementations with isolation between the application and the
* cryptography module, implementers should take care to ensure that
* the definitions that are exposed to applications match what the
* module implements.
*
* Macros that compute sizes whose values do not depend on the * Macros that compute sizes whose values do not depend on the
* implementation are in crypto.h. * implementation are in crypto.h.
*/ */

10
include/psa/crypto_struct.h
View file

@ -2,6 +2,16 @@
* \file psa/crypto_struct.h * \file psa/crypto_struct.h
* *
* \brief PSA cryptography module: Mbed TLS structured type implementations * \brief PSA cryptography module: Mbed TLS structured type implementations
*
* \note This file may not be included directly. Applications must
* include psa/crypto.h.
*
* This file contains the definitions of some data structures with
* implementation-specific definitions.
*
* In implementations with isolation between the application and the
* cryptography module, it is expected that the front-end and the back-end
* would have different versions of this file.
*/ */
/* /*
* Copyright (C) 2018, ARM Limited, All Rights Reserved * Copyright (C) 2018, ARM Limited, All Rights Reserved