* [PATCH v2 1/2] staging: media: atomisp: clean up block comment formatting in headers
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
2026-07-10 12:02 ` [PATCH v2 2/2] staging: media: atomisp: fix grammar and punctuation in inline comments Bohdan D. Marcus
1 sibling, 0 replies; 3+ messages in thread
From: Bohdan D. Marcus @ 2026-07-10 12:02 UTC (permalink / raw)
To: Andy Shevchenko, Mauro Carvalho Chehab, Sakari Ailus
Cc: linux-media, linux-kernel, Bohdan D. Marcus
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
^ permalink raw reply related [flat|nested] 3+ messages in thread* [PATCH v2 2/2] staging: media: atomisp: fix grammar and punctuation in inline comments
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 ` [PATCH v2 1/2] staging: media: atomisp: clean up block comment formatting in headers Bohdan D. Marcus
@ 2026-07-10 12:02 ` Bohdan D. Marcus
1 sibling, 0 replies; 3+ messages in thread
From: Bohdan D. Marcus @ 2026-07-10 12:02 UTC (permalink / raw)
To: Andy Shevchenko, Mauro Carvalho Chehab, Sakari Ailus
Cc: linux-media, linux-kernel, Bohdan D. Marcus
Update inline comments in atomisp_cmd.c to comply with kernel
coding style and maintainer expectations. Specifically:
- Capitalize the first letter of sentences.
- Add missing periods at the end of statements.
- Ensure proper spacing before closing comment tags.
Signed-off-by: Bohdan D. Marcus <bohdandmarcus@gmail.com>
---
drivers/staging/media/atomisp/pci/atomisp_cmd.c | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/drivers/staging/media/atomisp/pci/atomisp_cmd.c b/drivers/staging/media/atomisp/pci/atomisp_cmd.c
index 6cd500d9f..6a4d04813 100644
--- a/drivers/staging/media/atomisp/pci/atomisp_cmd.c
+++ b/drivers/staging/media/atomisp/pci/atomisp_cmd.c
@@ -216,7 +216,7 @@ int atomisp_freq_scaling(struct atomisp_device *isp,
curr_rules.fps = fps;
curr_rules.run_mode = isp->asd.run_mode->val;
- /* search for the target frequency by looping freq rules*/
+ /* Search for the target frequency by looping freq rules. */
for (i = 0; i < dfs->dfs_table_size; i++) {
if (curr_rules.width != dfs->dfs_table[i].width &&
dfs->dfs_table[i].width != ISP_FREQ_RULE_ANY)
@@ -259,7 +259,7 @@ int atomisp_freq_scaling(struct atomisp_device *isp,
*/
int atomisp_reset(struct atomisp_device *isp)
{
- /* Reset ISP by power-cycling it */
+ /* Reset ISP by power-cycling it. */
int ret = 0;
dev_dbg(isp->dev, "%s\n", __func__);
@@ -420,7 +420,7 @@ static void print_csi_rx_errors(enum mipi_port_id port,
dev_err(isp->dev, " line sync error");
}
-/* Clear irq reg */
+/* Clear irq reg. */
static void clear_irq_reg(struct atomisp_device *isp)
{
struct pci_dev *pdev = to_pci_dev(isp->dev);
@@ -431,7 +431,7 @@ static void clear_irq_reg(struct atomisp_device *isp)
pci_write_config_dword(pdev, PCI_INTERRUPT_CTRL, msg_ret);
}
-/* interrupt handling function*/
+/* Interrupt handling function. */
irqreturn_t atomisp_isr(int irq, void *dev)
{
struct atomisp_device *isp = (struct atomisp_device *)dev;
@@ -481,7 +481,7 @@ irqreturn_t atomisp_isr(int irq, void *dev)
if ((irq_infos & IA_CSS_IRQ_INFO_INPUT_SYSTEM_ERROR) ||
(irq_infos & IA_CSS_IRQ_INFO_IF_ERROR)) {
- /* handle mipi receiver error */
+ /* Handle mipi receiver error. */
u32 rx_infos;
enum mipi_port_id port;
@@ -532,7 +532,7 @@ void atomisp_clear_css_buffer_counters(struct atomisp_sub_device *asd)
asd->dis_bufs_in_css = 0;
}
-/* 0x100000 is the start of dmem inside SP */
+/* 0x100000 is the start of dmem inside SP. */
#define SP_DMEM_BASE 0x100000
void dump_sp_dmem(struct atomisp_device *isp, unsigned int addr,
@@ -614,7 +614,7 @@ void atomisp_flush_video_pipe(struct atomisp_video_pipe *pipe, enum vb2_buffer_s
spin_unlock_irqrestore(&pipe->irq_lock, irqflags);
}
-/* clean out the parameters that did not apply */
+/* Clean out the parameters that did not apply. */
void atomisp_flush_params_queue(struct atomisp_video_pipe *pipe)
{
struct atomisp_css_params_with_list *param;
--
2.55.0
^ permalink raw reply related [flat|nested] 3+ messages in thread