iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source 
Miscellaneous improvements:
  - Start comment blocks with "/**" to enable kerneldoc,
  - Mark parameters using "@" instead of "\param",
  - Fix typos in parameter names,
  - Add missing function names to kerneldoc headers,
  - 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:22 +01:00 committed by Herbert Xu
parent 5c68361f57
commit 31568ab832
2 changed files with 24 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
drivers/crypto/ccree/cc_sram_mgr.c
View File

@ -10,6 +10,9 @@
* Returns zero for success, negative value otherwise.
*
* @drvdata: Associated device driver context
*
* Return:
* 0 for success, negative error code for failure.
*/
int cc_sram_mgr_init(struct cc_drvdata *drvdata)
{
@ -29,11 +32,14 @@ int cc_sram_mgr_init(struct cc_drvdata *drvdata)
return 0;
}
/*!
* Allocated buffer from SRAM pool.
/**
* cc_sram_alloc() - Allocate buffer from SRAM pool.
*
* \param drvdata
* \param size The requested bytes to allocate
* @drvdata: Associated device driver context
* @size: The requested numer of bytes to allocate
*
* Return:
* Address offset in SRAM or NULL_SRAM_ADDR for failure.
*/
u32 cc_sram_alloc(struct cc_drvdata *drvdata, u32 size)
{
@ -64,7 +70,7 @@ u32 cc_sram_alloc(struct cc_drvdata *drvdata, u32 size)
*
* @src: A pointer to array of words to set as consts.
* @dst: The target SRAM buffer to set into
* @nelements: The number of words in "src" array
* @nelement: The number of words in "src" array
* @seq: A pointer to the given IN/OUT descriptor sequence
* @seq_len: A pointer to the given IN/OUT sequence length
*/

22
drivers/crypto/ccree/cc_sram_mgr.h
View File

@ -12,22 +12,26 @@ struct cc_drvdata;
#define NULL_SRAM_ADDR ((u32)-1)
/*!
* Initializes SRAM pool.
/**
* cc_sram_mgr_init() - Initializes SRAM pool.
* The first X bytes of SRAM are reserved for ROM usage, hence, pool
* starts right after X bytes.
*
* \param drvdata
* @drvdata: Associated device driver context
*
* \return int Zero for success, negative value otherwise.
* Return:
* Zero for success, negative value otherwise.
*/
int cc_sram_mgr_init(struct cc_drvdata *drvdata);
/*!
* Allocate buffer from SRAM pool.
/**
* cc_sram_alloc() - Allocate buffer from SRAM pool.
*
* \param drvdata
* \param size The requested bytes to allocate
* @drvdata: Associated device driver context
* @size: The requested bytes to allocate
*
* Return:
* Address offset in SRAM or NULL_SRAM_ADDR for failure.
*/
u32 cc_sram_alloc(struct cc_drvdata *drvdata, u32 size);
@ -38,7 +42,7 @@ u32 cc_sram_alloc(struct cc_drvdata *drvdata, u32 size);
*
* @src: A pointer to array of words to set as consts.
* @dst: The target SRAM buffer to set into
* @nelements: The number of words in "src" array
* @nelement: The number of words in "src" array
* @seq: A pointer to the given IN/OUT descriptor sequence
* @seq_len: A pointer to the given IN/OUT sequence length
*/