crypto: x86/aesni - update docs for aesni-intel module

Commit Message

Eric Biggers Aug. 27, 2024, 6:50 p.m. UTC

From: Eric Biggers <[e-mail]>

Update the kconfig help and module description to reflect that VAES
instructions are now used in some cases.  Also fix XTR => XCTR.

Signed-off-by: Eric Biggers <[e-mail]>
---
 arch/x86/crypto/Kconfig            | 8 ++++++--
 arch/x86/crypto/aesni-intel_glue.c | 2 +-
 2 files changed, 7 insertions(+), 3 deletions(-)


base-commit: 3c44d31cb34ce4eb8311a2e73634d57702948230

Comments

Herbert Xu Sept. 6, 2024, 7:06 a.m. UTC | #1

Eric Biggers <[e-mail]> wrote:
> From: Eric Biggers <[e-mail]>
> 
> Update the kconfig help and module description to reflect that VAES
> instructions are now used in some cases.  Also fix XTR => XCTR.
> 
> Signed-off-by: Eric Biggers <[e-mail]>
> ---
> arch/x86/crypto/Kconfig            | 8 ++++++--
> arch/x86/crypto/aesni-intel_glue.c | 2 +-
> 2 files changed, 7 insertions(+), 3 deletions(-)

Patch applied.  Thanks.

Patch

diff --git a/arch/x86/crypto/Kconfig b/arch/x86/crypto/Kconfig
index 24875e6295f2d..7b1bebed879df 100644
--- a/arch/x86/crypto/Kconfig
+++ b/arch/x86/crypto/Kconfig
@@ -12,25 +12,29 @@  config CRYPTO_CURVE25519_X86
 
 	  Architecture: x86_64 using:
 	  - ADX (large integer arithmetic)
 
 config CRYPTO_AES_NI_INTEL
-	tristate "Ciphers: AES, modes: ECB, CBC, CTS, CTR, XTR, XTS, GCM (AES-NI)"
+	tristate "Ciphers: AES, modes: ECB, CBC, CTS, CTR, XCTR, XTS, GCM (AES-NI/VAES)"
 	depends on X86
 	select CRYPTO_AEAD
 	select CRYPTO_LIB_AES
 	select CRYPTO_LIB_GF128MUL
 	select CRYPTO_ALGAPI
 	select CRYPTO_SKCIPHER
 	select CRYPTO_SIMD
 	help
 	  Block cipher: AES cipher algorithms
 	  AEAD cipher: AES with GCM
-	  Length-preserving ciphers: AES with ECB, CBC, CTS, CTR, XTR, XTS
+	  Length-preserving ciphers: AES with ECB, CBC, CTS, CTR, XCTR, XTS
 
 	  Architecture: x86 (32-bit and 64-bit) using:
 	  - AES-NI (AES new instructions)
+	  - VAES (Vector AES)
+
+	  Some algorithm implementations are supported only in 64-bit builds,
+	  and some have additional prerequisites such as AVX2 or AVX512.
 
 config CRYPTO_BLOWFISH_X86_64
 	tristate "Ciphers: Blowfish, modes: ECB, CBC"
 	depends on X86 && 64BIT
 	select CRYPTO_SKCIPHER
diff --git a/arch/x86/crypto/aesni-intel_glue.c b/arch/x86/crypto/aesni-intel_glue.c
index d63ba9eaba3e4..b0dd835554997 100644
--- a/arch/x86/crypto/aesni-intel_glue.c
+++ b/arch/x86/crypto/aesni-intel_glue.c
@@ -1748,8 +1748,8 @@  static void __exit aesni_exit(void)
 }
 
 late_initcall(aesni_init);
 module_exit(aesni_exit);
 
-MODULE_DESCRIPTION("Rijndael (AES) Cipher Algorithm, Intel AES-NI instructions optimized");
+MODULE_DESCRIPTION("AES cipher and modes, optimized with AES-NI or VAES instructions");
 MODULE_LICENSE("GPL");
 MODULE_ALIAS_CRYPTO("aes");