All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Bohdan D. Marcus" <bohdandmarcus@gmail.com>
To: Andy Shevchenko <andriy.shevchenko@linux.intel.com>,
	Mauro Carvalho Chehab <mchehab@kernel.org>,
	Sakari Ailus <sakari.ailus@linux.intel.com>
Cc: linux-media@vger.kernel.org, linux-kernel@vger.kernel.org,
	"Bohdan D. Marcus" <bohdandmarcus@gmail.com>
Subject: [PATCH v2 1/2] staging: media: atomisp: clean up block comment formatting in headers
Date: Fri, 10 Jul 2026 15:02:53 +0300	[thread overview]
Message-ID: <20260710120254.23565-2-bohdandmarcus@gmail.com> (raw)
In-Reply-To: <20260710120254.23565-1-bohdandmarcus@gmail.com>

Fix block comment formatting issues in several header files to comply
with the Linux kernel coding style. Specifically:
- Move trailing '*/' to a separate line.
- Align '*' on subsequent lines of block comments.
- Reformat excessively long lines and remove Doxygen-style tags.

Signed-off-by: Bohdan D. Marcus <bohdandmarcus@gmail.com>
---
 .../media/atomisp/pci/atomisp_internal.h      |  5 +-
 .../staging/media/atomisp/pci/ia_css_mipi.h   | 19 +++---
 .../staging/media/atomisp/pci/ia_css_timer.h  | 63 ++++++++++---------
 3 files changed, 45 insertions(+), 42 deletions(-)

diff --git a/drivers/staging/media/atomisp/pci/atomisp_internal.h b/drivers/staging/media/atomisp/pci/atomisp_internal.h
index 5a69580b8..3d26b2138 100644
--- a/drivers/staging/media/atomisp/pci/atomisp_internal.h
+++ b/drivers/staging/media/atomisp/pci/atomisp_internal.h
@@ -19,7 +19,7 @@
 #include <media/v4l2-async.h>
 #include <media/v4l2-subdev.h>
 
-/* ISP2400*/
+/* ISP2400 */
 #include "ia_css_types.h"
 #include "sh_css_legacy.h"
 
@@ -182,7 +182,8 @@ struct atomisp_device {
 	struct atomisp_mipi_csi2_device csi2_port[ATOMISP_CAMERA_NR_PORTS];
 
 	/* Purpose of mutex is to protect and serialize use of isp data
-	 * structures and css API calls. */
+	 * structures and css API calls.
+	 */
 	struct mutex mutex;
 
 	/*
diff --git a/drivers/staging/media/atomisp/pci/ia_css_mipi.h b/drivers/staging/media/atomisp/pci/ia_css_mipi.h
index 9fb178c8f..5c803672e 100644
--- a/drivers/staging/media/atomisp/pci/ia_css_mipi.h
+++ b/drivers/staging/media/atomisp/pci/ia_css_mipi.h
@@ -16,17 +16,18 @@
 #include "ia_css_stream_format.h"
 #include "ia_css_input_port.h"
 
-/* @brief Calculate the size of a mipi frame.
- *
- * @param[in]	width		The width (in pixels) of the frame.
- * @param[in]	height		The height (in lines) of the frame.
- * @param[in]	format		The frame (MIPI) format.
- * @param[in]	hasSOLandEOL	Whether frame (MIPI) contains (optional) SOL and EOF packets.
- * @param[in]	embedded_data_size_words		Embedded data size in memory words.
- * @param		size_mem_words					The mipi frame size in memory words (32B).
- * @return		The error code.
+/**
+ * ia_css_mipi_frame_calculate_size() - Calculate the size of a mipi frame.
+ * @width: The width (in pixels) of the frame.
+ * @height: The height (in lines) of the frame.
+ * @format: The frame (MIPI) format.
+ * @hasSOLandEOL: Whether frame (MIPI) contains (optional) SOL and EOF packets.
+ * @embedded_data_size_words: Embedded data size in memory words.
+ * @size_mem_words: The mipi frame size in memory words (32B).
  *
  * Calculate the size of a mipi frame, based on the resolution and format.
+ *
+ * Return: The error code.
  */
 int
 ia_css_mipi_frame_calculate_size(const unsigned int width,
diff --git a/drivers/staging/media/atomisp/pci/ia_css_timer.h b/drivers/staging/media/atomisp/pci/ia_css_timer.h
index da752834a..f20c315ea 100644
--- a/drivers/staging/media/atomisp/pci/ia_css_timer.h
+++ b/drivers/staging/media/atomisp/pci/ia_css_timer.h
@@ -1,61 +1,62 @@
 /* SPDX-License-Identifier: GPL-2.0 */
-/**
-Support for Intel Camera Imaging ISP subsystem.
-Copyright (c) 2010 - 2015, Intel Corporation.
-
-*/
+/*
+ * Support for Intel Camera Imaging ISP subsystem.
+ * Copyright (c) 2010 - 2015, Intel Corporation.
+ */
 
 #ifndef __IA_CSS_TIMER_H
 #define __IA_CSS_TIMER_H
 
-/* @file
- * Timer interface definitions
+/*
+ * Timer interface definitions.
  */
-#include <type_support.h>		/* for uint32_t */
+#include <type_support.h>       /* for uint32_t */
 #include "ia_css_err.h"
 
-/* @brief timer reading definition */
+/* Timer reading definition. */
 typedef u32 clock_value_t;
 
-/* @brief 32 bit clock tick,(timestamp based on timer-value of CSS-internal timer)*/
+/* 32 bit clock tick (timestamp based on timer-value of CSS-internal timer). */
 struct ia_css_clock_tick {
-	clock_value_t ticks; /** measured time in ticks.*/
+	clock_value_t ticks; /* Measured time in ticks. */
 };
 
-/* @brief TIMER event codes */
+/* TIMER event codes. */
 enum ia_css_tm_event {
 	IA_CSS_TM_EVENT_AFTER_INIT,
-	/** Timer Event after Initialization */
+	/* Timer event after initialization. */
 	IA_CSS_TM_EVENT_MAIN_END,
-	/** Timer Event after end of Main */
+	/* Timer event after end of main. */
 	IA_CSS_TM_EVENT_THREAD_START,
-	/** Timer Event after thread start */
+	/* Timer event after thread start. */
 	IA_CSS_TM_EVENT_FRAME_PROC_START,
-	/** Timer Event after Frame Process Start */
+	/* Timer event after frame process start. */
 	IA_CSS_TM_EVENT_FRAME_PROC_END
-	/** Timer Event after Frame Process End */
+	/* Timer event after frame process end. */
 };
 
-/* @brief code measurement common struct */
+/* Code measurement common struct. */
 struct ia_css_time_meas {
-	clock_value_t	start_timer_value;	/** measured time in ticks */
-	clock_value_t	end_timer_value;	/** measured time in ticks */
+	clock_value_t start_timer_value; /* Measured time in ticks. */
+	clock_value_t end_timer_value;   /* Measured time in ticks. */
 };
 
-/**@brief SIZE_OF_IA_CSS_CLOCK_TICK_STRUCT checks to ensure correct alignment for struct ia_css_clock_tick. */
+/*
+ * SIZE_OF_IA_CSS_CLOCK_TICK_STRUCT
+ * Checks to ensure correct alignment for struct ia_css_clock_tick.
+ */
 #define SIZE_OF_IA_CSS_CLOCK_TICK_STRUCT sizeof(clock_value_t)
-/* @brief checks to ensure correct alignment for ia_css_time_meas. */
+
+/* Checks to ensure correct alignment for ia_css_time_meas. */
 #define SIZE_OF_IA_CSS_TIME_MEAS_STRUCT (sizeof(clock_value_t) \
 					+ sizeof(clock_value_t))
 
-/* @brief API to fetch timer count directly
-*
-* @param curr_ts [out] measured count value
-* @return 0 if success
-*
-*/
-int
-ia_css_timer_get_current_tick(
-    struct ia_css_clock_tick *curr_ts);
+/**
+ * ia_css_timer_get_current_tick() - API to fetch timer count directly.
+ * @curr_ts: [out] Measured count value.
+ *
+ * Return: 0 if success.
+ */
+int ia_css_timer_get_current_tick(struct ia_css_clock_tick *curr_ts);
 
 #endif  /* __IA_CSS_TIMER_H */
-- 
2.55.0


  reply	other threads:[~2026-07-10 12:04 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-07-10 12:02 [PATCH v2 0/2] staging: media: atomisp: clean up comment formatting and grammar Bohdan D. Marcus
2026-07-10 12:02 ` Bohdan D. Marcus [this message]
2026-07-12 10:34   ` [PATCH v2 1/2] staging: media: atomisp: clean up block comment formatting in headers Andy Shevchenko
2026-07-12 13:02     ` Bohdan Derkach
2026-07-10 12:02 ` [PATCH v2 2/2] staging: media: atomisp: fix grammar and punctuation in inline comments Bohdan D. Marcus
2026-07-12 10:35   ` Andy Shevchenko

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260710120254.23565-2-bohdandmarcus@gmail.com \
    --to=bohdandmarcus@gmail.com \
    --cc=andriy.shevchenko@linux.intel.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=mchehab@kernel.org \
    --cc=sakari.ailus@linux.intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.