2023-03-08 03:45:12

by Randy Dunlap

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

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 <[email protected]>
Reported-by: kernel test robot <[email protected]>
Link: lore.kernel.org/r/[email protected]
Cc: Aditya Srivastava <[email protected]>
Cc: Joerg Roedel <[email protected]>
Cc: Will Deacon <[email protected]>
Cc: Robin Murphy <[email protected]>
Cc: [email protected]
Cc: Timur Tabi <[email protected]>
Cc: Varun Sethi <[email protected]>
Cc: Emil Medve <[email protected]>
---
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


2023-03-08 16:18:32

by Timur Tabi

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

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 <[email protected]>

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

2023-03-09 02:12:52

by Baolu Lu

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

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<[email protected]>
> Reported-by: kernel test robot<[email protected]>
> Link:lore.kernel.org/r/[email protected]
> Cc: Aditya Srivastava<[email protected]>
> Cc: Joerg Roedel<[email protected]>
> Cc: Will Deacon<[email protected]>
> Cc: Robin Murphy<[email protected]>
> Cc:[email protected]
> Cc: Timur Tabi<[email protected]>
> Cc: Varun Sethi<[email protected]>
> Cc: Emil Medve<[email protected]>

Reviewed-by: Lu Baolu <[email protected]>

Best regards,
baolu

2023-03-22 14:04:50

by Joerg Roedel

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

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.