Commit 39def87b authored by Frank Li's avatar Frank Li Committed by Vinod Koul
Browse files

dmaengine: fsl-dpaa2-qdma: Fix kernel-doc check warning 



Fix all kernel-doc warnings under drivers/dma/fsl-dpaa2-qdma.

./scripts/kernel-doc -v -none drivers/dma/fsl-dpaa2-qdma/*
drivers/dma/fsl-dpaa2-qdma/dpdmai.c:262: warning: Function parameter or struct member 'queue_idx' not described in 'dpdmai_set_rx_queue'
drivers/dma/fsl-dpaa2-qdma/dpdmai.c:339: warning: Excess function parameter 'fqid' description in 'dpdmai_get_tx_queue'
...

Reported-by: default avatarkernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202404190019.t4IhmbHh-lkp@intel.com/


Signed-off-by: default avatarFrank Li <Frank.Li@nxp.com>
Link: https://lore.kernel.org/r/20240418185851.3221726-1-Frank.Li@nxp.com


Signed-off-by: default avatarVinod Koul <vkoul@kernel.org>
parent d850b5ba

drivers/dma/fsl-dpaa2-qdma/dpdmai.c

+4 −1
Original line number Diff line number Diff line
@@ -251,6 +251,7 @@ EXPORT_SYMBOL_GPL(dpdmai_get_attributes); 
 * @mc_io:	Pointer to MC portal's I/O object

 * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'

 * @token:	Token of DPDMAI object

 * @queue_idx:	DMA queue index

 * @priority:	Select the queue relative to number of

 *		priorities configured at DPDMAI creation

 * @cfg:	Rx queue configuration
@@ -286,6 +287,7 @@ EXPORT_SYMBOL_GPL(dpdmai_set_rx_queue); 
 * @mc_io:	Pointer to MC portal's I/O object

 * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'

 * @token:	Token of DPDMAI object

 * @queue_idx:	DMA Queue index

 * @priority:	Select the queue relative to number of

 *				priorities configured at DPDMAI creation

 * @attr:	Returned Rx queue attributes
@@ -328,9 +330,10 @@ EXPORT_SYMBOL_GPL(dpdmai_get_rx_queue); 
 * @mc_io:	Pointer to MC portal's I/O object

 * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'

 * @token:	Token of DPDMAI object

 * @queue_idx:	DMA queue index

 * @priority:	Select the queue relative to number of

 *			priorities configured at DPDMAI creation

 * @fqid:	Returned Tx queue

 * @attr:	Returned DMA Tx queue attributes

 *

 * Return:	'0' on Success; Error code otherwise.

 */

drivers/dma/fsl-dpaa2-qdma/dpdmai.h

+7 −8
Original line number Diff line number Diff line
@@ -45,25 +45,26 @@ 
 * Contains initialization APIs and runtime control APIs for DPDMAI

 */



/**

/*

 * Maximum number of Tx/Rx priorities per DPDMAI object

 */

#define DPDMAI_PRIO_NUM		2



/* DPDMAI queue modification options */



/**

/*

 * Select to modify the user's context associated with the queue

 */

#define DPDMAI_QUEUE_OPT_USER_CTX	0x1



/**

/*

 * Select to modify the queue's destination

 */

#define DPDMAI_QUEUE_OPT_DEST		0x2



/**

 * struct dpdmai_cfg - Structure representing DPDMAI configuration

 * @num_queues:	Number of the DMA queues

 * @priorities: Priorities for the DMA hardware processing; valid priorities are

 *	configured with values 1-8; the entry following last valid entry

 *	should be configured with 0
@@ -77,15 +78,13 @@ struct dpdmai_cfg { 
 * struct dpdmai_attr - Structure representing DPDMAI attributes

 * @id: DPDMAI object ID

 * @version: DPDMAI version

 * @version.major: DPDMAI major version

 * @version.minor: DPDMAI minor version

 * @num_of_priorities: number of priorities

 * @num_of_queues: number of the DMA queues

 */

struct dpdmai_attr {

	int	id;

	/**

	 * struct version - DPDMAI version

	 * @major: DPDMAI major version

	 * @minor: DPDMAI minor version

	 */

	struct {

		u16 major;

		u16 minor;