[PATCH] iommu/fsl: fix all kernel-doc warnings in fsl_pamu.c

[PATCH] iommu/fsl: fix all kernel-doc warnings in fsl_pamu.c

[Randy Dunlap]

Fix kernel-doc warnings as reported by the kernel test robot:

fsl_pamu.c:192: warning: expecting prototype for pamu_config_paace(). Prototype was for pamu_config_ppaace() instead
fsl_pamu.c:239: warning: Function parameter or member 'omi_index' not described in 'get_ome_index'
fsl_pamu.c:239: warning: Function parameter or member 'dev' not described in 'get_ome_index'
fsl_pamu.c:332: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Setup operation mapping and stash destinations for QMAN and QMAN portal.
fsl_pamu.c:361: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Setup the operation mapping table for various devices. This is a static

Fixes: 695093e38c3e ("iommu/fsl: Freescale PAMU driver and iommu implementation.")
Fixes: cd70d4659ff3 ("iommu/fsl: Various cleanups")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reported-by: kernel test robot <lkp@intel.com>
Link: lore.kernel.org/r/202302281151.B1WtZvSC-lkp@intel.com
Cc: Aditya Srivastava <yashsri421@gmail.com>
Cc: Joerg Roedel <joro@8bytes.org>
Cc: Will Deacon <will@kernel.org>
Cc: Robin Murphy <robin.murphy@arm.com>
Cc: iommu@lists.linux.dev
Cc: Timur Tabi <timur@tabi.org>
Cc: Varun Sethi <Varun.Sethi@freescale.com>
Cc: Emil Medve <Emilian.Medve@Freescale.com>
---
 drivers/iommu/fsl_pamu.c |    9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff -- a/drivers/iommu/fsl_pamu.c b/drivers/iommu/fsl_pamu.c
--- a/drivers/iommu/fsl_pamu.c
+++ b/drivers/iommu/fsl_pamu.c
@@ -178,7 +178,7 @@ int pamu_update_paace_stash(int liodn, u
 }
 
 /**
- * pamu_config_paace() - Sets up PPAACE entry for specified liodn
+ * pamu_config_ppaace() - Sets up PPAACE entry for specified liodn
  *
  * @liodn: Logical IO device number
  * @omi: Operation mapping index -- if ~omi == 0 then omi not defined
@@ -232,7 +232,8 @@ int pamu_config_ppaace(int liodn, u32 om
 /**
  * get_ome_index() - Returns the index in the operation mapping table
  *                   for device.
- * @*omi_index: pointer for storing the index value
+ * @omi_index: pointer for storing the index value
+ * @dev: target device
  *
  */
 void get_ome_index(u32 *omi_index, struct device *dev)
@@ -328,7 +329,7 @@ found_cpu_node:
 #define QMAN_PORTAL_PAACE 2
 #define BMAN_PAACE 3
 
-/**
+/*
  * Setup operation mapping and stash destinations for QMAN and QMAN portal.
  * Memory accesses to QMAN and BMAN private memory need not be coherent, so
  * clear the PAACE entry coherency attribute for them.
@@ -357,7 +358,7 @@ static void setup_qbman_paace(struct paa
 	}
 }
 
-/**
+/*
  * Setup the operation mapping table for various devices. This is a static
  * table where each table index corresponds to a particular device. PAMU uses
  * this table to translate device transaction to appropriate corenet

Re: [PATCH] iommu/fsl: fix all kernel-doc warnings in fsl_pamu.c

[Timur Tabi]

On 3/7/23 9:45 PM, Randy Dunlap wrote:
> Fix kernel-doc warnings as reported by the kernel test robot:
> 
> fsl_pamu.c:192: warning: expecting prototype for pamu_config_paace(). Prototype was for pamu_config_ppaace() instead
> fsl_pamu.c:239: warning: Function parameter or member 'omi_index' not described in 'get_ome_index'
> fsl_pamu.c:239: warning: Function parameter or member 'dev' not described in 'get_ome_index'
> fsl_pamu.c:332: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>   * Setup operation mapping and stash destinations for QMAN and QMAN portal.
> fsl_pamu.c:361: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>   * Setup the operation mapping table for various devices. This is a static
> 
> Fixes: 695093e38c3e ("iommu/fsl: Freescale PAMU driver and iommu implementation.")
> Fixes: cd70d4659ff3 ("iommu/fsl: Various cleanups")

Acked-by: Timur Tabi <timur@kernel.org>

One a side note, I'm pretty sure the @freescale.com addresses in the cc: 
list are invalid, so I've removed them.

Re: [PATCH] iommu/fsl: fix all kernel-doc warnings in fsl_pamu.c

[Baolu Lu]

On 3/8/23 11:45 AM, Randy Dunlap wrote:
> Fix kernel-doc warnings as reported by the kernel test robot:
> 
> fsl_pamu.c:192: warning: expecting prototype for pamu_config_paace(). Prototype was for pamu_config_ppaace() instead
> fsl_pamu.c:239: warning: Function parameter or member 'omi_index' not described in 'get_ome_index'
> fsl_pamu.c:239: warning: Function parameter or member 'dev' not described in 'get_ome_index'
> fsl_pamu.c:332: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>   * Setup operation mapping and stash destinations for QMAN and QMAN portal.
> fsl_pamu.c:361: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>   * Setup the operation mapping table for various devices. This is a static
> 
> Fixes: 695093e38c3e ("iommu/fsl: Freescale PAMU driver and iommu implementation.")
> Fixes: cd70d4659ff3 ("iommu/fsl: Various cleanups")
> Signed-off-by: Randy Dunlap<rdunlap@infradead.org>
> Reported-by: kernel test robot<lkp@intel.com>
> Link:lore.kernel.org/r/202302281151.B1WtZvSC-lkp@intel.com
> Cc: Aditya Srivastava<yashsri421@gmail.com>
> Cc: Joerg Roedel<joro@8bytes.org>
> Cc: Will Deacon<will@kernel.org>
> Cc: Robin Murphy<robin.murphy@arm.com>
> Cc:iommu@lists.linux.dev
> Cc: Timur Tabi<timur@tabi.org>
> Cc: Varun Sethi<Varun.Sethi@freescale.com>
> Cc: Emil Medve<Emilian.Medve@Freescale.com>

Reviewed-by: Lu Baolu <baolu.lu@linux.intel.com>

Best regards,
baolu

Re: [PATCH] iommu/fsl: fix all kernel-doc warnings in fsl_pamu.c

[Joerg Roedel]

On Tue, Mar 07, 2023 at 07:45:04PM -0800, Randy Dunlap wrote:
>  drivers/iommu/fsl_pamu.c |    9 +++++----
>  1 file changed, 5 insertions(+), 4 deletions(-)

Applied, thanks.