[PATCH 0/3] Fix kernel-doc warnings dfl files

[PATCH 0/3] Fix kernel-doc warnings dfl files

[Basheer Ahmed Muddebihal]

Fixed the kernel-doc warnings in drivers/fpga/dfl.c, drivers/fpga/dfl.h
and include/linux/dfl.h. Each file commit has a list of warnings fixed. 

Basheer Ahmed Muddebihal (3):
  fpga: dfl: Fix kernel-doc warning in dfl.h for revision
  fpga: dfl: Fix kernel-doc warnings in include/linux/dfl.h
  fpga: dfl: Fix kernel-doc warnings in drivers/fpga/dfl.c

 drivers/fpga/dfl.c  | 5 +++--
 drivers/fpga/dfl.h  | 1 +
 include/linux/dfl.h | 4 ++++
 3 files changed, 8 insertions(+), 2 deletions(-)

-- 
2.34.1

[PATCH 1/3] fpga: dfl: Fix kernel-doc warning in dfl.h for revision

[Basheer Ahmed Muddebihal]

Fixed the following warning:
drivers/fpga/dfl.h:255: warning: Function parameter or member 'revision' not described in 'dfl_feature'

Signed-off-by: Basheer Ahmed Muddebihal <basheer.ahmed.muddebihal@linux.intel.com>
---
 drivers/fpga/dfl.h | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/fpga/dfl.h b/drivers/fpga/dfl.h
index 06cfcd5e84bb..766429e618f6 100644
--- a/drivers/fpga/dfl.h
+++ b/drivers/fpga/dfl.h
@@ -231,6 +231,7 @@ struct dfl_feature_irq_ctx {
  *
  * @dev: ptr to pdev of the feature device which has the sub feature.
  * @id: sub feature id.
+ * @revision: sub feature revision.
  * @resource_index: each sub feature has one mmio resource for its registers.
  *		    this index is used to find its mmio resource from the
  *		    feature dev (platform device)'s resources.
-- 
2.34.1

[PATCH 2/3] fpga: dfl: Fix kernel-doc warnings in include/linux/dfl.h

[Basheer Ahmed Muddebihal]

Fixed the following warnings:
include/linux/dfl.h:21: warning: Enum value 'FME_ID' not described in enum 'dfl_id_type'
include/linux/dfl.h:21: warning: Enum value 'PORT_ID' not described in enum 'dfl_id_type'
include/linux/dfl.h:21: warning: Enum value 'DFL_ID_MAX' not described in enum 'dfl_id_type'
include/linux/dfl.h:47: warning: Function parameter or member 'revision' not described in 'dfl_device'

Signed-off-by: Basheer Ahmed Muddebihal <basheer.ahmed.muddebihal@linux.intel.com>
---
 include/linux/dfl.h | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/include/linux/dfl.h b/include/linux/dfl.h
index 431636a0dc78..4caa2d99d8dc 100644
--- a/include/linux/dfl.h
+++ b/include/linux/dfl.h
@@ -13,6 +13,9 @@
 
 /**
  * enum dfl_id_type - define the DFL FIU types
+ * @FME_ID: dfl id for FPGA Management Engine node.
+ * @PORT_ID: dfl id for Port.
+ * @DFL_ID_MAX: maximum number for dfl ids.
  */
 enum dfl_id_type {
 	FME_ID = 0,
@@ -27,6 +30,7 @@ enum dfl_id_type {
  * @id: id of the dfl device.
  * @type: type of DFL FIU of the device. See enum dfl_id_type.
  * @feature_id: feature identifier local to its DFL FIU type.
+ * @revision: feature revision local to its DFL FIU type.
  * @mmio_res: mmio resource of this dfl device.
  * @irqs: list of Linux IRQ numbers of this dfl device.
  * @num_irqs: number of IRQs supported by this dfl device.
-- 
2.34.1

[PATCH 3/3] fpga: dfl: Fix kernel-doc warnings in drivers/fpga/dfl.c

[Basheer Ahmed Muddebihal]

Fixed the following warnings:
drivers/fpga/dfl.c:54: warning: cannot understand function prototype: 'struct dfl_dev_info '
drivers/fpga/dfl.c:74: warning: cannot understand function prototype: 'struct dfl_chardev_info '
drivers/fpga/dfl.c:725: warning: Function parameter or member 'revision' not described in 'dfl_feature_info'

Signed-off-by: Basheer Ahmed Muddebihal <basheer.ahmed.muddebihal@linux.intel.com>
---
 drivers/fpga/dfl.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/drivers/fpga/dfl.c b/drivers/fpga/dfl.c
index 6bff39ff21a0..4086cabd25b0 100644
--- a/drivers/fpga/dfl.c
+++ b/drivers/fpga/dfl.c
@@ -45,7 +45,7 @@ static const char *dfl_pdata_key_strings[DFL_ID_MAX] = {
 };
 
 /**
- * dfl_dev_info - dfl feature device information.
+ * struct dfl_dev_info - dfl feature device information.
  * @name: name string of the feature platform device.
  * @dfh_id: id value in Device Feature Header (DFH) register by DFL spec.
  * @id: idr id of the feature dev.
@@ -67,7 +67,7 @@ static struct dfl_dev_info dfl_devs[] = {
 };
 
 /**
- * dfl_chardev_info - chardev information of dfl feature device
+ * struct dfl_chardev_info - chardev information of dfl feature device
  * @name: nmae string of the char device.
  * @devt: devt of the char device.
  */
@@ -708,6 +708,7 @@ struct build_feature_devs_info {
  * struct dfl_feature_info - sub feature info collected during feature dev build
  *
  * @fid: id of this sub feature.
+ * @revision: revision of this sub feature.
  * @mmio_res: mmio resource of this sub feature.
  * @ioaddr: mapped base address of mmio resource.
  * @node: node in sub_features linked list.
-- 
2.34.1

Re: [PATCH 1/3] fpga: dfl: Fix kernel-doc warning in dfl.h for revision

[Xu Yilun]

On Thu, May 19, 2022 at 03:12:47PM -0700, Basheer Ahmed Muddebihal wrote:
> Fixed the following warning:

Please help specify which tool reports this issue here. Is it lkp?

> drivers/fpga/dfl.h:255: warning: Function parameter or member 'revision' not described in 'dfl_feature'
> 

Please add the 'Fixes' tag here.
Please also add the 'Reported-by' tag here.

> Signed-off-by: Basheer Ahmed Muddebihal <basheer.ahmed.muddebihal@linux.intel.com>
> ---
>  drivers/fpga/dfl.h | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/drivers/fpga/dfl.h b/drivers/fpga/dfl.h
> index 06cfcd5e84bb..766429e618f6 100644
> --- a/drivers/fpga/dfl.h
> +++ b/drivers/fpga/dfl.h
> @@ -231,6 +231,7 @@ struct dfl_feature_irq_ctx {
>   *
>   * @dev: ptr to pdev of the feature device which has the sub feature.
>   * @id: sub feature id.
> + * @revision: sub feature revision.
>   * @resource_index: each sub feature has one mmio resource for its registers.
>   *		    this index is used to find its mmio resource from the
>   *		    feature dev (platform device)'s resources.
> -- 
> 2.34.1

Re: [PATCH 2/3] fpga: dfl: Fix kernel-doc warnings in include/linux/dfl.h

[Xu Yilun]

On Thu, May 19, 2022 at 03:12:48PM -0700, Basheer Ahmed Muddebihal wrote:
> Fixed the following warnings:
> include/linux/dfl.h:21: warning: Enum value 'FME_ID' not described in enum 'dfl_id_type'
> include/linux/dfl.h:21: warning: Enum value 'PORT_ID' not described in enum 'dfl_id_type'
> include/linux/dfl.h:21: warning: Enum value 'DFL_ID_MAX' not described in enum 'dfl_id_type'
> include/linux/dfl.h:47: warning: Function parameter or member 'revision' not described in 'dfl_device'
> 
> Signed-off-by: Basheer Ahmed Muddebihal <basheer.ahmed.muddebihal@linux.intel.com>
> ---
>  include/linux/dfl.h | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/include/linux/dfl.h b/include/linux/dfl.h
> index 431636a0dc78..4caa2d99d8dc 100644
> --- a/include/linux/dfl.h
> +++ b/include/linux/dfl.h
> @@ -13,6 +13,9 @@
>  
>  /**
>   * enum dfl_id_type - define the DFL FIU types
> + * @FME_ID: dfl id for FPGA Management Engine node.

DFL FIU type for FPGA Management Engine. Is it better?

> + * @PORT_ID: dfl id for Port.

DFL FIU type for Port.

> + * @DFL_ID_MAX: maximum number for dfl ids.

number of valid DFL FIU types.

>   */
>  enum dfl_id_type {
>  	FME_ID = 0,
> @@ -27,6 +30,7 @@ enum dfl_id_type {
>   * @id: id of the dfl device.
>   * @type: type of DFL FIU of the device. See enum dfl_id_type.
>   * @feature_id: feature identifier local to its DFL FIU type.
> + * @revision: feature revision local to its DFL FIU type.

Local to its DFL FIU type? Every feature manages it's own revesion, is
it?

Thanks,
Yilun

>   * @mmio_res: mmio resource of this dfl device.
>   * @irqs: list of Linux IRQ numbers of this dfl device.
>   * @num_irqs: number of IRQs supported by this dfl device.
> -- 
> 2.34.1