From: Mahad Ibrahim <mahad.ibrahim.dev@gmail.com>
To: Mahad Ibrahim <mahad.ibrahim.dev@gmail.com>,
Hans de Goede <hansg@kernel.org>,
Mauro Carvalho Chehab <mchehab@kernel.org>
Cc: Andy Shevchenko <andy@kernel.org>,
Sakari Ailus <sakari.ailus@linux.intel.com>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
linux-media@vger.kernel.org, linux-staging@lists.linux.dev,
linux-kernel@vger.kernel.org
Subject: [PATCH v1 5/5] media: atomisp: Convert comments to kernel-doc
Date: Mon, 5 Jan 2026 00:05:09 +0500 [thread overview]
Message-ID: <20260104190509.19683-6-mahad.ibrahim.dev@gmail.com> (raw)
In-Reply-To: <20260104190509.19683-1-mahad.ibrahim.dev@gmail.com>
Existing comments in mmu_public.h used Doxygen syntax and had
inconsistent formatting.
Convert the function documentation to the standard kernel-doc format to
adhere to the Linux kernel coding style.
Signed-off-by: Mahad Ibrahim <mahad.ibrahim.dev@gmail.com>
---
.../hive_isp_css_include/host/mmu_public.h | 59 +++++++++----------
1 file changed, 27 insertions(+), 32 deletions(-)
diff --git a/drivers/staging/media/atomisp/pci/hive_isp_css_include/host/mmu_public.h b/drivers/staging/media/atomisp/pci/hive_isp_css_include/host/mmu_public.h
index 611755e88e9f..b321f4101193 100644
--- a/drivers/staging/media/atomisp/pci/hive_isp_css_include/host/mmu_public.h
+++ b/drivers/staging/media/atomisp/pci/hive_isp_css_include/host/mmu_public.h
@@ -11,49 +11,45 @@
#include "device_access.h"
#include "assert_support.h"
-/*
- *! Set the page table base index of MMU[ID]
- *
- *\param ID[in] MMU identifier
- *\param base_index[in] page table base index
+/**
+ * mmu_set_page_table_base_index() - Set the page table base index of MMU[ID]
+ * @ID: MMU identifier
+ * @base_index: page table base index
*
- *\return none, MMU[ID].page_table_base_index = base_index
+ * Return: none, MMU[ID].page_table_base_index = base_index
*/
void mmu_set_page_table_base_index(const mmu_ID_t ID, const hrt_data base_index);
-/*
- *! Get the page table base index of MMU[ID]
+/**
+ * mmu_get_page_table_base_index() - Get the page table base index of MMU[ID]
+ * @ID: MMU identifier
*
- *\param ID[in] MMU identifier
- *
- *\return MMU[ID].page_table_base_index
+ * Return: MMU[ID].page_table_base_index
*/
hrt_data mmu_get_page_table_base_index(const mmu_ID_t ID);
-/*
- *! Invalidate the page table cache of MMU[ID]
- *
- *\param ID[in] MMU identifier
+/**
+ * mmu_invalidate_cache() - nvalidate the page table cache of MMU[ID]
+ * @ID: MMU identifier
*
- *\return none
+ * Return: none
*/
void mmu_invalidate_cache(const mmu_ID_t ID);
-/*
- *! Invalidate the page table cache of all MMUs
+/**
+ * mmu_invalidate_cache_all() - Invalidate the page table cache of all MMUs
*
- *\return none
+ * Return: none
*/
void mmu_invalidate_cache_all(void);
-/*
- *! Write to a control register of MMU[ID]
- *
- *\param ID[in] MMU identifier
- *\param reg[in] register index
- *\param value[in] The data to be written
+/**
+ * mmu_reg_store() - Write to a control register of MMU[ID]
+ * @ID: MMU identifier
+ * @reg: register index
+ * @value: The data to be written
*
- *\return none, MMU[ID].ctrl[reg] = value
+ * Return: none, MMU[ID].ctrl[reg] = value
*/
static inline void mmu_reg_store(const mmu_ID_t ID, const unsigned int reg, const hrt_data value)
{
@@ -62,13 +58,12 @@ static inline void mmu_reg_store(const mmu_ID_t ID, const unsigned int reg, cons
ia_css_device_store_uint32(MMU_BASE[ID] + reg * sizeof(hrt_data), value);
}
-/*
- *! Read from a control register of MMU[ID]
- *
- *\param ID[in] MMU identifier
- *\param reg[in] register index
+/**
+ * mmu_reg_load() - Read from a control register of MMU[ID]
+ * @ID: MMU identifier
+ * @reg: register index
*
- *\return MMU[ID].ctrl[reg]
+ * Return: MMU[ID].ctrl[reg]
*/
static inline hrt_data mmu_reg_load(const mmu_ID_t ID, const unsigned int reg)
{
--
2.47.3
prev parent reply other threads:[~2026-01-04 19:06 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-01-04 19:05 [PATCH v1 0/5] media: atomisp: Cleanup and documentation fixes for mmu_public.h Mahad Ibrahim
2026-01-04 19:05 ` [PATCH v1 1/5] media: atomisp: Remove redundant return statement Mahad Ibrahim
2026-01-04 19:05 ` [PATCH v1 2/5] media: atomisp: Fix function signature alignment Mahad Ibrahim
2026-01-04 19:05 ` [PATCH v1 3/5] media: atomisp: Fix block comment coding style Mahad Ibrahim
2026-01-04 19:05 ` [PATCH v1 4/5] media: atomisp: Fix erroneous parameter descriptions Mahad Ibrahim
2026-01-04 19:05 ` Mahad Ibrahim [this message]
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=20260104190509.19683-6-mahad.ibrahim.dev@gmail.com \
--to=mahad.ibrahim.dev@gmail.com \
--cc=andy@kernel.org \
--cc=gregkh@linuxfoundation.org \
--cc=hansg@kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-media@vger.kernel.org \
--cc=linux-staging@lists.linux.dev \
--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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox