Skip to content

Commit 39def87

Browse files
nxpfranklivinodkoul
authored andcommitted
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: kernel test robot <[email protected]> Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/ Signed-off-by: Frank Li <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Vinod Koul <[email protected]>
1 parent d850b5b commit 39def87

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -251,6 +251,7 @@ EXPORT_SYMBOL_GPL(dpdmai_get_attributes);
251251
* @mc_io: Pointer to MC portal's I/O object
252252
* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
253253
* @token: Token of DPDMAI object
254+
* @queue_idx: DMA queue index
254255
* @priority: Select the queue relative to number of
255256
* priorities configured at DPDMAI creation
256257
* @cfg: Rx queue configuration
@@ -286,6 +287,7 @@ EXPORT_SYMBOL_GPL(dpdmai_set_rx_queue);
286287
* @mc_io: Pointer to MC portal's I/O object
287288
* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
288289
* @token: Token of DPDMAI object
290+
* @queue_idx: DMA Queue index
289291
* @priority: Select the queue relative to number of
290292
* priorities configured at DPDMAI creation
291293
* @attr: Returned Rx queue attributes
@@ -328,9 +330,10 @@ EXPORT_SYMBOL_GPL(dpdmai_get_rx_queue);
328330
* @mc_io: Pointer to MC portal's I/O object
329331
* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
330332
* @token: Token of DPDMAI object
333+
* @queue_idx: DMA queue index
331334
* @priority: Select the queue relative to number of
332335
* priorities configured at DPDMAI creation
333-
* @fqid: Returned Tx queue
336+
* @attr: Returned DMA Tx queue attributes
334337
*
335338
* Return: '0' on Success; Error code otherwise.
336339
*/

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

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,25 +45,26 @@
4545
* Contains initialization APIs and runtime control APIs for DPDMAI
4646
*/
4747

48-
/**
48+
/*
4949
* Maximum number of Tx/Rx priorities per DPDMAI object
5050
*/
5151
#define DPDMAI_PRIO_NUM 2
5252

5353
/* DPDMAI queue modification options */
5454

55-
/**
55+
/*
5656
* Select to modify the user's context associated with the queue
5757
*/
5858
#define DPDMAI_QUEUE_OPT_USER_CTX 0x1
5959

60-
/**
60+
/*
6161
* Select to modify the queue's destination
6262
*/
6363
#define DPDMAI_QUEUE_OPT_DEST 0x2
6464

6565
/**
6666
* struct dpdmai_cfg - Structure representing DPDMAI configuration
67+
* @num_queues: Number of the DMA queues
6768
* @priorities: Priorities for the DMA hardware processing; valid priorities are
6869
* configured with values 1-8; the entry following last valid entry
6970
* should be configured with 0
@@ -77,15 +78,13 @@ struct dpdmai_cfg {
7778
* struct dpdmai_attr - Structure representing DPDMAI attributes
7879
* @id: DPDMAI object ID
7980
* @version: DPDMAI version
81+
* @version.major: DPDMAI major version
82+
* @version.minor: DPDMAI minor version
8083
* @num_of_priorities: number of priorities
84+
* @num_of_queues: number of the DMA queues
8185
*/
8286
struct dpdmai_attr {
8387
int id;
84-
/**
85-
* struct version - DPDMAI version
86-
* @major: DPDMAI major version
87-
* @minor: DPDMAI minor version
88-
*/
8988
struct {
9089
u16 major;
9190
u16 minor;

0 commit comments

Comments
 (0)