Received-SPF: pass (google.com: domain of linux-kernel+bounces-150653-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) client-ip=2604:1380:45e3:2400::1;
From: Frank Li <Frank.Li@nxp.com>
To: Vinod Koul <vkoul@kernel.org>,
	dmaengine@vger.kernel.org (open list:DMA GENERIC OFFLOAD ENGINE SUBSYSTEM),
	linux-kernel@vger.kernel.org (open list)
Cc: imx@lists.linux.dev
Subject: [PATCH 1/1] dmaengine: fsl-dpaa2-qdma: Fix kernel-doc check warning
Date: Thu, 18 Apr 2024 14:58:49 -0400
Message-Id: <20240418185851.3221726-1-Frank.Li@nxp.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?us-ascii?Q?y0tUHZJQeTXufA55CQknVNcHoFdB/m08TXXq9hrUh6yFFXRBCXKJVbIvdC4e?=
 =?us-ascii?Q?nNJh8RxIfI+htcACoyuuc02oxmZPFxYGzQewXaIqy2M/xegyUOhhTh61+rM1?=
 =?us-ascii?Q?FTaDdJttmLonX9CzESbJPpwux42txiQX2DzDb48jekUTalLYrDoe+Iymn7F1?=
 =?us-ascii?Q?2JbHGO1k3AafSdEOIGZVaazQVdMxQgG4v3NTmW42ldhl1bgXju31wPZlZUhA?=
 =?us-ascii?Q?CWSL4N2ho7xWn2l1AB2XW96M5KVqSh9ftU3rho3AMWosGG1eVcqeqBoMv0fH?=
 =?us-ascii?Q?wAe07Mp7jdLSOWHhii2XLkKlTWrN1DKJSsoDTpPKiLwFg6WI+dQRHSeooQnm?=
 =?us-ascii?Q?hAty9OycBTuIZPPCJY2p/khpSXA87ou/Bub7cJU5FyOdU8KCNQnVUfo0l9Hi?=
 =?us-ascii?Q?kJ8bZKyJbiiQEt9vTuqJPSY0LsdRaH9800fW+UUo0H18ziN0QurrSz4abSym?=
 =?us-ascii?Q?cyPo6HDoySNbQ0opa+uawJEWrfElmyZZ8dyhLNB3BmeP+R0bXiJIbylvk2D4?=
 =?us-ascii?Q?15XfO9YFV/g4ADPNarC0DgZJRVq/i66pEwxIu2pvOQk+L8hC2qUP849phEIv?=
 =?us-ascii?Q?PsNWsvT9ONw0FJXaOj9DUw/40tOu07e4aUn8iS7uhXFc4g9BlKGLkSoeHJgP?=
 =?us-ascii?Q?15aKuxyzecUJbX3KQrAJUdOTtcoSIEsd6u9gAig5lkNXEkjyO0sMXVHhNGjo?=
 =?us-ascii?Q?fTPsu0mdEa9+qFGrN7uHkALTCsqmNw3OD92GNWJo62O/MeTes/reVJQV/41f?=
 =?us-ascii?Q?hBGYUHaiByat72CtaJ+B1MIgrsNte0EbJtKDc0IfufMfLTZmYYpziOFclvVt?=
 =?us-ascii?Q?0WV0RHaSniNCtH/Sxh2L4XvGWHGEYkA8yz7kEepce77GY3HBIrJQFRmM4eW4?=
 =?us-ascii?Q?NzvEn95k1BHF+Y8i5Zu55MIWIsrGWCPTiFPcyXV2Gu+8Rzn2uMF/DYxZQTIA?=
 =?us-ascii?Q?T54JCsIL5XXz6gygm6MXrYEqQg7PwgK2o4FeyF8594Z9xq9joV5WkeJwSZIx?=
 =?us-ascii?Q?+Yr65ln+mpK8hDfJgw/HGgK2NEWQdivDuaqF2HHwDX4UQYYz6p5SOW78J2Hx?=
 =?us-ascii?Q?91h46yAHUGv6RiPM3VTsVw7naJqNG45ZAchnWF0VntfmsJPh2CuZ1I8RmNJ0?=
 =?us-ascii?Q?IhFB8JH7S0LAbMkBWSI8JHZg9Pk12C+CYjemA1F45wVImIsBF9M4k9y0jims?=
 =?us-ascii?Q?H5XzHUvDTAX/SruKejN2icTBk+L0ArJAuyeA+aTrykO+5co6FOQG7MH3JW4E?=
 =?us-ascii?Q?e61fUfON7Ns3NIcf2GKglSSFuVivM4Esr66fdlnvTsruolk6DIb7b+LtCln+?=
 =?us-ascii?Q?PuUczCTH4bfEnxDv0vHVPXQae2pSmswqDYtH2c8Mia+Q8JYb3zFeMvHspkOv?=
 =?us-ascii?Q?KQ44bEOFJwNxm3yqJY9r1+xyxMtSPCeXQMAmZFMnsWz/tNAX2T6ZqyLIWhGD?=
 =?us-ascii?Q?LCl0ExZVJ5bFk9hx5ZdoIMXCTkmudIeJzjAz5cJwrotfWS6zbIld9zpLGSHs?=
 =?us-ascii?Q?vNgNrJeBK7WXygC4Qb6xFReTqc6aNDGoPeVTqsF4hj2V5DuH+kdg0lz8a8p1?=
 =?us-ascii?Q?t6IRhUXxPDfqYS3NUZhb/pISd6W0MRliyEv2YYfQ?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: e953cc57-8587-4380-e0a2-08dc5fd99e8c
X-MS-Exchange-CrossTenant-AuthSource: PAXPR04MB9642.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 18 Apr 2024 18:59:05.3591
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: IZq3cP6s1ELjY41oqi61UtfG/2x1jJ+IvOfanaeWpQpMbga5KijmJVkhs7uhHQYOUt7YY2LjR1peJi5ZgwfJ8A==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DBBPR04MB7788

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 <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202404190019.t4IhmbHh-lkp@intel.com/
Signed-off-by: Frank Li <Frank.Li@nxp.com>
---
 drivers/dma/fsl-dpaa2-qdma/dpdmai.c |  5 ++++-
 drivers/dma/fsl-dpaa2-qdma/dpdmai.h | 15 +++++++--------
 2 files changed, 11 insertions(+), 9 deletions(-)

diff --git a/drivers/dma/fsl-dpaa2-qdma/dpdmai.c b/drivers/dma/fsl-dpaa2-qdma/dpdmai.c
index a824450fe19c2..36897b41ee7e5 100644
--- a/drivers/dma/fsl-dpaa2-qdma/dpdmai.c
+++ b/drivers/dma/fsl-dpaa2-qdma/dpdmai.c
@@ -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.
  */
diff --git a/drivers/dma/fsl-dpaa2-qdma/dpdmai.h b/drivers/dma/fsl-dpaa2-qdma/dpdmai.h
index 1efca2a305334..3fe7d8327366e 100644
--- a/drivers/dma/fsl-dpaa2-qdma/dpdmai.h
+++ b/drivers/dma/fsl-dpaa2-qdma/dpdmai.h
@@ -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;
-- 
2.34.1