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

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

drivers/crypto/ccree/cc_hash.c

+6 −5
Original line number Diff line number Diff line
@@ -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

 *

 * \param drvdata

 * \param mode The Hash mode. Supported modes: MD5/SHA1/SHA224/SHA256

 * @drvdata: Associated device driver context

 * @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)

{

drivers/crypto/ccree/cc_hash.h

+12 −12
Original line number Diff line number Diff line
@@ -80,26 +80,26 @@ int cc_hash_alloc(struct cc_drvdata *drvdata); 
int cc_init_hash_sram(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

 * \param mode The Hash mode. Supported modes:

 *             MD5/SHA1/SHA224/SHA256/SHA384/SHA512

 * @drvdata: Associated device driver context

 * @mode: The Hash mode. Supported modes: 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);



/*!

 * 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

 *

 * \param drvdata

 * \param mode The Hash mode. Supported modes:

 *             MD5/SHA1/SHA224/SHA256/SHA384/SHA512

 * @drvdata: Associated device driver context

 * @mode: The Hash mode. Supported modes: 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);