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>
This commit is contained in:
Geert Uytterhoeven 2020-02-11 19:19:19 +01:00 committed by Herbert Xu
parent 67b74a4683
commit ae02fcfeac
1 changed files with 11 additions and 5 deletions

View File

@ -73,9 +73,13 @@ static void cc_copy_mac(struct device *dev, struct aead_request *req,
/** /**
* cc_get_sgl_nents() - Get scatterlist number of entries. * cc_get_sgl_nents() - Get scatterlist number of entries.
* *
* @dev: Device object
* @sg_list: SG list * @sg_list: SG list
* @nbytes: [IN] Total SGL data bytes. * @nbytes: [IN] Total SGL data bytes.
* @lbytes: [OUT] Returns the amount of bytes at the last entry * @lbytes: [OUT] Returns the amount of bytes at the last entry
*
* Return:
* Number of entries in the scatterlist
*/ */
static unsigned int cc_get_sgl_nents(struct device *dev, static unsigned int cc_get_sgl_nents(struct device *dev,
struct scatterlist *sg_list, struct scatterlist *sg_list,
@ -102,11 +106,13 @@ static unsigned int cc_get_sgl_nents(struct device *dev,
* cc_copy_sg_portion() - Copy scatter list data, * cc_copy_sg_portion() - Copy scatter list data,
* from to_skip to end, to dest and vice versa * from to_skip to end, to dest and vice versa
* *
* @dest: * @dev: Device object
* @sg: * @dest: Buffer to copy to/from
* @to_skip: * @sg: SG list
* @end: * @to_skip: Number of bytes to skip before copying
* @direct: * @end: Offset of last byte to copy
* @direct: Transfer direction (true == from SG list to buffer, false == from
* buffer to SG list)
*/ */
void cc_copy_sg_portion(struct device *dev, u8 *dest, struct scatterlist *sg, void cc_copy_sg_portion(struct device *dev, u8 *dest, struct scatterlist *sg,
u32 to_skip, u32 end, enum cc_sg_cpy_direct direct) u32 to_skip, u32 end, enum cc_sg_cpy_direct direct)