Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.31 as permitted sender) client-ip=23.128.96.31;
From:   Alain Volmat <alain.volmat@foss.st.com>
To:     Hugues Fruchet <hugues.fruchet@foss.st.com>,
        Alain Volmat <alain.volmat@foss.st.com>,
        Mauro Carvalho Chehab <mchehab@kernel.org>,
        Maxime Coquelin <mcoquelin.stm32@gmail.com>,
        Alexandre Torgue <alexandre.torgue@foss.st.com>
CC:     Hans Verkuil <hverkuil@xs4all.nl>,
        Sakari Ailus <sakari.ailus@iki.fi>,
        <linux-media@vger.kernel.org>,
        <linux-stm32@st-md-mailman.stormreply.com>,
        <linux-arm-kernel@lists.infradead.org>,
        <linux-kernel@vger.kernel.org>
Subject: [PATCH] media: stm32-dcmipp: correct kerneldoc issues in dcmipp-common
Date:   Tue, 28 Nov 2023 21:14:03 +0100
Message-ID: <20231128201404.237856-1-alain.volmat@foss.st.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
Precedence: bulk

Correct kerneldoc issues regarding:
  - dcmipp_ent_sd_register
  - dcmipp_pads_init
  - dcmipp_colorimetry_clamp

Rename as well dcmipp_pads_init parameter from pads_flag to pads_flags.

Signed-off-by: Alain Volmat <alain.volmat@foss.st.com>
---
 .../media/platform/st/stm32/stm32-dcmipp/dcmipp-common.c    | 4 ++--
 .../media/platform/st/stm32/stm32-dcmipp/dcmipp-common.h    | 6 ++++--
 2 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/drivers/media/platform/st/stm32/stm32-dcmipp/dcmipp-common.c b/drivers/media/platform/st/stm32/stm32-dcmipp/dcmipp-common.c
index d4f149f7e1b7..562933e08d62 100644
--- a/drivers/media/platform/st/stm32/stm32-dcmipp/dcmipp-common.c
+++ b/drivers/media/platform/st/stm32/stm32-dcmipp/dcmipp-common.c
@@ -14,7 +14,7 @@
 #include "dcmipp-common.h"
 
 /* Helper function to allocate and initialize pads */
-struct media_pad *dcmipp_pads_init(u16 num_pads, const unsigned long *pads_flag)
+struct media_pad *dcmipp_pads_init(u16 num_pads, const unsigned long *pads_flags)
 {
 	struct media_pad *pads;
 	unsigned int i;
@@ -27,7 +27,7 @@ struct media_pad *dcmipp_pads_init(u16 num_pads, const unsigned long *pads_flag)
 	/* Initialize the pads */
 	for (i = 0; i < num_pads; i++) {
 		pads[i].index = i;
-		pads[i].flags = pads_flag[i];
+		pads[i].flags = pads_flags[i];
 	}
 
 	return pads;
diff --git a/drivers/media/platform/st/stm32/stm32-dcmipp/dcmipp-common.h b/drivers/media/platform/st/stm32/stm32-dcmipp/dcmipp-common.h
index 5fd26d6f857a..69cfa67ffeeb 100644
--- a/drivers/media/platform/st/stm32/stm32-dcmipp/dcmipp-common.h
+++ b/drivers/media/platform/st/stm32/stm32-dcmipp/dcmipp-common.h
@@ -33,7 +33,7 @@
 #define DCMIPP_XFER_FUNC_DEFAULT	V4L2_XFER_FUNC_DEFAULT
 
 /**
- * struct dcmipp_colorimetry_clamp - Adjust colorimetry parameters
+ * dcmipp_colorimetry_clamp() - Adjust colorimetry parameters
  *
  * @fmt:		the pointer to struct v4l2_pix_format or
  *			struct v4l2_mbus_framefmt
@@ -103,7 +103,7 @@ struct dcmipp_ent_device {
  * Helper functions to allocate/initialize pads
  */
 struct media_pad *dcmipp_pads_init(u16 num_pads,
-				   const unsigned long *pads_flag);
+				   const unsigned long *pads_flags);
 
 /**
  * dcmipp_pads_cleanup - free pads
@@ -130,6 +130,8 @@ static inline void dcmipp_pads_cleanup(struct media_pad *pads)
  * @pads_flag:	flags to use in each pad
  * @sd_int_ops:	pointer to &struct v4l2_subdev_internal_ops
  * @sd_ops:	pointer to &struct v4l2_subdev_ops.
+ * @handler:	func pointer of the irq handler
+ * @thread_fn:	func pointer of the threaded irq handler
  *
  * Helper function initialize and register the struct dcmipp_ent_device and
  * struct v4l2_subdev which represents a subdev node in the topology
-- 
2.34.1