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

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



Miscellaneous improvements:
  - Start comment blocks with "/**" to enable kerneldoc,
  - Mark parameters using "@" instead of "\param",
  - Fix copied is_dout parameter of cc_send_request(),
  - 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 dc16c9f7

drivers/crypto/ccree/cc_request_mgr.c

+22 −19
Original line number Diff line number Diff line
@@ -206,12 +206,13 @@ static void enqueue_seq(struct cc_drvdata *drvdata, struct cc_hw_desc seq[], 
	}

}



/*!

 * Completion will take place if and only if user requested completion

 * by cc_send_sync_request().

/**

 * request_mgr_complete() - Completion will take place if and only if user

 * requested completion by cc_send_sync_request().

 *

 * \param dev

 * \param dx_compl_h The completion event to signal

 * @dev: Device pointer

 * @dx_compl_h: The completion event to signal

 * @dummy: unused error code

 */

static void request_mgr_complete(struct device *dev, void *dx_compl_h,

				 int dummy)
@@ -264,15 +265,15 @@ static int cc_queues_status(struct cc_drvdata *drvdata, 
	return -ENOSPC;

}



/*!

 * Enqueue caller request to crypto hardware.

/**

 * cc_do_send_request() - Enqueue caller request to crypto hardware.

 * Need to be called with HW lock held and PM running

 *

 * \param drvdata

 * \param cc_req The request to enqueue

 * \param desc The crypto sequence

 * \param len The crypto sequence length

 * \param add_comp If "true": add an artificial dout DMA to mark completion

 * @drvdata: Associated device driver context

 * @cc_req: The request to enqueue

 * @desc: The crypto sequence

 * @len: The crypto sequence length

 * @add_comp: If "true": add an artificial dout DMA to mark completion

 *

 */

static void cc_do_send_request(struct cc_drvdata *drvdata,
@@ -486,16 +487,18 @@ int cc_send_sync_request(struct cc_drvdata *drvdata, 
	return 0;

}



/*!

 * Enqueue caller request to crypto hardware during init process.

 * assume this function is not called in middle of a flow,

/**

 * send_request_init() - Enqueue caller request to crypto hardware during init

 * process.

 * Assume this function is not called in the middle of a flow,

 * since we set QUEUE_LAST_IND flag in the last descriptor.

 *

 * \param drvdata

 * \param desc The crypto sequence

 * \param len The crypto sequence length

 * @drvdata: Associated device driver context

 * @desc: The crypto sequence

 * @len: The crypto sequence length

 *

 * \return int Returns "0" upon success

 * Return:

 * Returns "0" upon success

 */

int send_request_init(struct cc_drvdata *drvdata, struct cc_hw_desc *desc,

		      unsigned int len)

drivers/crypto/ccree/cc_request_mgr.h

+9 −10
Original line number Diff line number Diff line
@@ -12,18 +12,17 @@ 


int cc_req_mgr_init(struct cc_drvdata *drvdata);



/*!

 * Enqueue caller request to crypto hardware.

/**

 * cc_send_request() - Enqueue caller request to crypto hardware.

 *

 * \param drvdata

 * \param cc_req The request to enqueue

 * \param desc The crypto sequence

 * \param len The crypto sequence length

 * \param is_dout If "true": completion is handled by the caller

 *	  If "false": this function adds a dummy descriptor completion

 *	  and waits upon completion signal.

 * @drvdata: Associated device driver context

 * @cc_req: The request to enqueue

 * @desc: The crypto sequence

 * @len: The crypto sequence length

 * @req: Asynchronous crypto request

 *

 * \return int Returns -EINPROGRESS or error

 * Return:

 * Returns -EINPROGRESS or error

 */

int cc_send_request(struct cc_drvdata *drvdata, struct cc_crypto_req *cc_req,

		    struct cc_hw_desc *desc, unsigned int len,