diff options
| author | Stephan Mueller <smueller@chronox.de> | 2016-10-21 04:54:22 +0200 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2016-12-13 16:37:54 -0700 |
| commit | 3b72c814a8e8cd638e1ba0da4dfce501e9dff5af (patch) | |
| tree | a79b261dd9f10bd3525ed97d1bb54058fc6d9a1e /Documentation/crypto/api-aead.rst | |
| parent | 868c97a846a73e937d835b09b8c885a69df50ec8 (diff) | |
| download | op-kernel-dev-3b72c814a8e8cd638e1ba0da4dfce501e9dff5af.zip op-kernel-dev-3b72c814a8e8cd638e1ba0da4dfce501e9dff5af.tar.gz | |
crypto: doc - convert crypto API documentation to Sphinx
With the conversion of the kernel crypto API DocBook to Sphinx, the
monolithic document is broken up into individual documents. The
documentation is unchanged with the exception of a slight reordering to
keep the individual document parts self-contained.
Signed-off-by: Stephan Mueller <smueller@chronox.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/crypto/api-aead.rst')
| -rw-r--r-- | Documentation/crypto/api-aead.rst | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/Documentation/crypto/api-aead.rst b/Documentation/crypto/api-aead.rst new file mode 100644 index 0000000..78a7ce4 --- /dev/null +++ b/Documentation/crypto/api-aead.rst @@ -0,0 +1,68 @@ +Authenticated Encryption With Associated Data (AEAD) Algorithm Definitions +-------------------------------------------------------------------------- + +.. kernel-doc:: include/crypto/aead.h + :doc: Authenticated Encryption With Associated Data (AEAD) Cipher API + +.. kernel-doc:: include/crypto/aead.h + :functions: aead_request + +.. kernel-doc:: include/crypto/aead.h + :functions: aead_alg + +Authenticated Encryption With Associated Data (AEAD) Cipher API +--------------------------------------------------------------- + +.. kernel-doc:: include/crypto/aead.h + :functions: crypto_alloc_aead + +.. kernel-doc:: include/crypto/aead.h + :functions: crypto_free_aead + +.. kernel-doc:: include/crypto/aead.h + :functions: crypto_aead_ivsize + +.. kernel-doc:: include/crypto/aead.h + :functions: crypto_aead_authsize + +.. kernel-doc:: include/crypto/aead.h + :functions: crypto_aead_blocksize + +.. kernel-doc:: include/crypto/aead.h + :functions: crypto_aead_setkey + +.. kernel-doc:: include/crypto/aead.h + :functions: crypto_aead_setauthsize + +.. kernel-doc:: include/crypto/aead.h + :functions: crypto_aead_encrypt + +.. kernel-doc:: include/crypto/aead.h + :functions: crypto_aead_decrypt + +Asynchronous AEAD Request Handle +-------------------------------- + +.. kernel-doc:: include/crypto/aead.h + :doc: Asynchronous AEAD Request Handle + +.. kernel-doc:: include/crypto/aead.h + :functions: crypto_aead_reqsize + +.. kernel-doc:: include/crypto/aead.h + :functions: aead_request_set_tfm + +.. kernel-doc:: include/crypto/aead.h + :functions: aead_request_alloc + +.. kernel-doc:: include/crypto/aead.h + :functions: aead_request_free + +.. kernel-doc:: include/crypto/aead.h + :functions: aead_request_set_callback + +.. kernel-doc:: include/crypto/aead.h + :functions: aead_request_set_crypt + +.. kernel-doc:: include/crypto/aead.h + :functions: aead_request_set_ad |
