Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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: Geert Uytterhoeven <geert+renesas@glider.be>
Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>

authored by

Geert Uytterhoeven and committed by
Herbert Xu
dc16c9f7 ae02fcfe

+18 -17
+6 -5
drivers/crypto/ccree/cc_hash.c
··· 2238 2238 } 2239 2239 } 2240 2240 2241 - /*! 2242 - * Gets the address of the initial digest in SRAM 2241 + /** 2242 + * cc_larval_digest_addr() - Get the address of the initial digest in SRAM 2243 2243 * according to the given hash mode 2244 2244 * 2245 - * \param drvdata 2246 - * \param mode The Hash mode. Supported modes: MD5/SHA1/SHA224/SHA256 2245 + * @drvdata: Associated device driver context 2246 + * @mode: The Hash mode. Supported modes: MD5/SHA1/SHA224/SHA256 2247 2247 * 2248 - * \return u32 The address of the initial digest in SRAM 2248 + * Return: 2249 + * The address of the initial digest in SRAM 2249 2250 */ 2250 2251 u32 cc_larval_digest_addr(void *drvdata, u32 mode) 2251 2252 {
+12 -12
drivers/crypto/ccree/cc_hash.h
··· 80 80 int cc_init_hash_sram(struct cc_drvdata *drvdata); 81 81 int cc_hash_free(struct cc_drvdata *drvdata); 82 82 83 - /*! 84 - * Gets the initial digest length 83 + /** 84 + * cc_digest_len_addr() - Gets the initial digest length 85 85 * 86 - * \param drvdata 87 - * \param mode The Hash mode. Supported modes: 88 - * MD5/SHA1/SHA224/SHA256/SHA384/SHA512 86 + * @drvdata: Associated device driver context 87 + * @mode: The Hash mode. Supported modes: MD5/SHA1/SHA224/SHA256/SHA384/SHA512 89 88 * 90 - * \return u32 returns the address of the initial digest length in SRAM 89 + * Return: 90 + * Returns the address of the initial digest length in SRAM 91 91 */ 92 92 u32 cc_digest_len_addr(void *drvdata, u32 mode); 93 93 94 - /*! 95 - * Gets the address of the initial digest in SRAM 94 + /** 95 + * cc_larval_digest_addr() - Gets the address of the initial digest in SRAM 96 96 * according to the given hash mode 97 97 * 98 - * \param drvdata 99 - * \param mode The Hash mode. Supported modes: 100 - * MD5/SHA1/SHA224/SHA256/SHA384/SHA512 98 + * @drvdata: Associated device driver context 99 + * @mode: The Hash mode. Supported modes: MD5/SHA1/SHA224/SHA256/SHA384/SHA512 101 100 * 102 - * \return u32 The address of the initial digest in SRAM 101 + * Return: 102 + * The address of the initial digest in SRAM 103 103 */ 104 104 u32 cc_larval_digest_addr(void *drvdata, u32 mode); 105 105