Commit b2161cc0 authored by Shiju Jose's avatar Shiju Jose Committed by Herbert Xu
Browse files

crypto: hisilicon - Fix doc warnings in sgl.c and qm.c 



Fix following warnings caused by mismatch between
function parameters and function comments.

drivers/crypto/hisilicon/sgl.c:256: warning: Excess function parameter 'hw_sgl_dma' description in 'hisi_acc_sg_buf_unmap'
drivers/crypto/hisilicon/sgl.c:256: warning: Excess function parameter 'pool' description in 'hisi_acc_sg_buf_unmap'
drivers/crypto/hisilicon/qm.c:1849: warning: Function parameter or member 'qp' not described in 'qm_drain_qp'
drivers/crypto/hisilicon/qm.c:2420: warning: Function parameter or member 'qm' not described in 'hisi_qm_set_vft'
drivers/crypto/hisilicon/qm.c:2420: warning: Function parameter or member 'fun_num' not described in 'hisi_qm_set_vft'
drivers/crypto/hisilicon/qm.c:2420: warning: Function parameter or member 'base' not described in 'hisi_qm_set_vft'
drivers/crypto/hisilicon/qm.c:2420: warning: Function parameter or member 'number' not described in 'hisi_qm_set_vft'
drivers/crypto/hisilicon/qm.c:2620: warning: Function parameter or member 'qm' not described in 'qm_clear_queues'

Signed-off-by: default avatarShiju Jose <shiju.jose@huawei.com>
Reviewed-by: default avatarZhou Wang <wangzhou1@hisilicon.com>
Signed-off-by: default avatarHerbert Xu <herbert@gondor.apana.org.au>
parent 02376161

drivers/crypto/hisilicon/qm.c

+13 −0
Original line number Diff line number Diff line
@@ -1843,6 +1843,9 @@ int hisi_qm_start_qp(struct hisi_qp *qp, unsigned long arg) 
EXPORT_SYMBOL_GPL(hisi_qm_start_qp);



/**

 * qm_drain_qp() - Drain a qp.

 * @qp: The qp we want to drain.

 *

 * Determine whether the queue is cleared by judging the tail pointers of

 * sq and cq.

 */
@@ -2486,6 +2489,12 @@ int hisi_qm_get_vft(struct hisi_qm *qm, u32 *base, u32 *number) 
EXPORT_SYMBOL_GPL(hisi_qm_get_vft);



/**

 * hisi_qm_set_vft() - Set vft to a qm.

 * @qm: The qm we want to set its vft.

 * @fun_num: The function number.

 * @base: The base number of queue in vft.

 * @number: The number of queues in vft.

 *

 * This function is alway called in PF driver, it is used to assign queues

 * among PF and VFs.

 *
@@ -2690,7 +2699,11 @@ static int qm_stop_started_qp(struct hisi_qm *qm) 
	return 0;

}





/**

 * qm_clear_queues() - Clear all queues memory in a qm.

 * @qm: The qm in which the queues will be cleared.

 *

 * This function clears all queues memory in a qm. Reset of accelerator can

 * use this to clear queues.

 */

drivers/crypto/hisilicon/sgl.c

+0 −2
Original line number Diff line number Diff line
@@ -246,8 +246,6 @@ EXPORT_SYMBOL_GPL(hisi_acc_sg_buf_map_to_hw_sgl); 
 * @dev: The device which hw sgl belongs to.

 * @sgl: Related scatterlist.

 * @hw_sgl: Virtual address of hw sgl.

 * @hw_sgl_dma: DMA address of hw sgl.

 * @pool: Pool which hw sgl is allocated in.

 *

 * This function unmaps allocated hw sgl.

 */