From fd691a5795c685065412fc9b2c25313371e5fde0 Mon Sep 17 00:00:00 2001 From: Jacob Barthelmeh Date: Mon, 7 May 2018 10:24:44 -0600 Subject: [PATCH] add aes init function to docs --- doc/dox_comments/header_files/aes.h | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/doc/dox_comments/header_files/aes.h b/doc/dox_comments/header_files/aes.h index d65f1a1f2..b4ab5a4f7 100644 --- a/doc/dox_comments/header_files/aes.h +++ b/doc/dox_comments/header_files/aes.h @@ -809,3 +809,31 @@ WOLFSSL_API int wc_AesXtsDecrypt(XtsAes* aes, byte* out, \sa wc_AesXtsSetKey */ WOLFSSL_API int wc_AesXtsFree(XtsAes* aes); + + +/*! + \ingroup AES + \brief Initialize Aes structure. Sets heap hint to be used and ID for use + with async hardware + \return 0 Success + + \param aes aes structure in to initialize + \param heap heap hint to use for malloc / free if needed + \param devId ID to use with async hardware + + _Example_ + \code + Aes enc; + void* hint = NULL; + int devId = INVALID_DEVID; //if not using async INVALID_DEVID is default + + //heap hint could be set here if used + + wc_AesInit(&aes, hint, devId); + \endcode + + \sa wc_AesSetKey + \sa wc_AesSetIV +*/ +WOLFSSL_API int wc_AesInit(Aes* aes, void* heap, int devId); +