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_buffer_mgr.c

Miscellaneous improvements:
- Add missing parameter and return value 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
ae02fcfe 67b74a46

+11 -5
+11 -5
drivers/crypto/ccree/cc_buffer_mgr.c
··· 73 73 /** 74 74 * cc_get_sgl_nents() - Get scatterlist number of entries. 75 75 * 76 + * @dev: Device object 76 77 * @sg_list: SG list 77 78 * @nbytes: [IN] Total SGL data bytes. 78 79 * @lbytes: [OUT] Returns the amount of bytes at the last entry 80 + * 81 + * Return: 82 + * Number of entries in the scatterlist 79 83 */ 80 84 static unsigned int cc_get_sgl_nents(struct device *dev, 81 85 struct scatterlist *sg_list, ··· 106 102 * cc_copy_sg_portion() - Copy scatter list data, 107 103 * from to_skip to end, to dest and vice versa 108 104 * 109 - * @dest: 110 - * @sg: 111 - * @to_skip: 112 - * @end: 113 - * @direct: 105 + * @dev: Device object 106 + * @dest: Buffer to copy to/from 107 + * @sg: SG list 108 + * @to_skip: Number of bytes to skip before copying 109 + * @end: Offset of last byte to copy 110 + * @direct: Transfer direction (true == from SG list to buffer, false == from 111 + * buffer to SG list) 114 112 */ 115 113 void cc_copy_sg_portion(struct device *dev, u8 *dest, struct scatterlist *sg, 116 114 u32 to_skip, u32 end, enum cc_sg_cpy_direct direct)