Doc: the SHA256/SHA512 options also cover SHA224/SHA384

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
This commit is contained in:
Gilles Peskine 2022-06-09 19:09:38 +02:00
parent 76c1c6b9c1
commit 9b3278b263

View File

@ -2813,9 +2813,9 @@
/** /**
* \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
* *
* Enable acceleration of the SHA-256 cryptographic hash algorithm with the * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
* Arm A64 cryptographic extensions if they are available at runtime. If not, * with the ARMv8 cryptographic extensions if they are available at runtime.
* it will fall back to the C implementation. * If not, the library will fall back to the C implementation.
* *
* \note If MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT is defined when building * \note If MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT is defined when building
* for a non-Aarch64 build it will be silently ignored. * for a non-Aarch64 build it will be silently ignored.
@ -2838,9 +2838,9 @@
/** /**
* \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
* *
* Enable acceleration of the SHA-256 cryptographic hash algorithm with the * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
* Arm A64 cryptographic extensions, which must be available at runtime (or * with the ARMv8 cryptographic extensions, which must be available at runtime
* an illegal instruction fault will occur). * or else an illegal instruction fault will occur.
* *
* \note This allows builds with a smaller code size than with * \note This allows builds with a smaller code size than with
* MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT * MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
@ -2896,9 +2896,9 @@
/** /**
* \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
* *
* Enable acceleration of the SHA-512 cryptographic hash algorithm with the * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
* Arm A64 cryptographic extensions if they are available at runtime. If not, * with the ARMv8 cryptographic extensions if they are available at runtime.
* it will fall back to the C implementation. * If not, the library will fall back to the C implementation.
* *
* \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
* for a non-Aarch64 build it will be silently ignored. * for a non-Aarch64 build it will be silently ignored.
@ -2923,9 +2923,9 @@
/** /**
* \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
* *
* Enable acceleration of the SHA-512 cryptographic hash algorithm with the * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
* Arm A64 cryptographic extensions, which must be available at runtime (or * with the ARMv8 cryptographic extensions, which must be available at runtime
* an illegal instruction fault will occur). * or else an illegal instruction fault will occur.
* *
* \note This allows builds with a smaller code size than with * \note This allows builds with a smaller code size than with
* MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT