Commit dc16c9f7 authored by Geert Uytterhoeven's avatar Geert Uytterhoeven Committed by Herbert Xu

crypto: ccree - improve kerneldoc in cc_hash.[ch]

Miscellaneous improvements:
  - Start comment blocks with "/**" to enable kerneldoc,
  - Mark parameters using "@" instead of "\param",
  - Add missing function names to kerneldoc headers,
  - Add missing parameter descriptions.
Signed-off-by: default avatarGeert Uytterhoeven <geert+renesas@glider.be>
Signed-off-by: default avatarHerbert Xu <herbert@gondor.apana.org.au>
parent ae02fcfe
...@@ -2238,14 +2238,15 @@ static const void *cc_larval_digest(struct device *dev, u32 mode) ...@@ -2238,14 +2238,15 @@ static const void *cc_larval_digest(struct device *dev, u32 mode)
} }
} }
/*! /**
* Gets the address of the initial digest in SRAM * cc_larval_digest_addr() - Get the address of the initial digest in SRAM
* according to the given hash mode * according to the given hash mode
* *
* \param drvdata * @drvdata: Associated device driver context
* \param mode The Hash mode. Supported modes: MD5/SHA1/SHA224/SHA256 * @mode: The Hash mode. Supported modes: MD5/SHA1/SHA224/SHA256
* *
* \return u32 The address of the initial digest in SRAM * Return:
* The address of the initial digest in SRAM
*/ */
u32 cc_larval_digest_addr(void *drvdata, u32 mode) u32 cc_larval_digest_addr(void *drvdata, u32 mode)
{ {
......
...@@ -80,26 +80,26 @@ int cc_hash_alloc(struct cc_drvdata *drvdata); ...@@ -80,26 +80,26 @@ int cc_hash_alloc(struct cc_drvdata *drvdata);
int cc_init_hash_sram(struct cc_drvdata *drvdata); int cc_init_hash_sram(struct cc_drvdata *drvdata);
int cc_hash_free(struct cc_drvdata *drvdata); int cc_hash_free(struct cc_drvdata *drvdata);
/*! /**
* Gets the initial digest length * cc_digest_len_addr() - Gets the initial digest length
* *
* \param drvdata * @drvdata: Associated device driver context
* \param mode The Hash mode. Supported modes: * @mode: The Hash mode. Supported modes: MD5/SHA1/SHA224/SHA256/SHA384/SHA512
* MD5/SHA1/SHA224/SHA256/SHA384/SHA512
* *
* \return u32 returns the address of the initial digest length in SRAM * Return:
* Returns the address of the initial digest length in SRAM
*/ */
u32 cc_digest_len_addr(void *drvdata, u32 mode); u32 cc_digest_len_addr(void *drvdata, u32 mode);
/*! /**
* Gets the address of the initial digest in SRAM * cc_larval_digest_addr() - Gets the address of the initial digest in SRAM
* according to the given hash mode * according to the given hash mode
* *
* \param drvdata * @drvdata: Associated device driver context
* \param mode The Hash mode. Supported modes: * @mode: The Hash mode. Supported modes: MD5/SHA1/SHA224/SHA256/SHA384/SHA512
* MD5/SHA1/SHA224/SHA256/SHA384/SHA512
* *
* \return u32 The address of the initial digest in SRAM * Return:
* The address of the initial digest in SRAM
*/ */
u32 cc_larval_digest_addr(void *drvdata, u32 mode); u32 cc_larval_digest_addr(void *drvdata, u32 mode);
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment