linux-fpga.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Basheer Ahmed Muddebihal  <basheer.ahmed.muddebihal@linux.intel.com>
To: hao.wu@intel.com, trix@redhat.com, mdf@kernel.org,
	yilun.xu@intel.com, linux-fpga@vger.kernel.org,
	linux-kernel@vger.kernel.org
Cc: matthew.gerlach@linux.intel.com, marpagan@redhat.com,
	tianfei.zhang@intel.com,
	Basheer Ahmed Muddebihal 
	<basheer.ahmed.muddebihal@linux.intel.com>
Subject: [PATCH 2/3] fpga: dfl: Fix kernel-doc warnings in include/linux/dfl.h
Date: Thu, 19 May 2022 15:12:48 -0700	[thread overview]
Message-ID: <20220519221249.858873-3-basheer.ahmed.muddebihal@linux.intel.com> (raw)
In-Reply-To: <20220519221249.858873-1-basheer.ahmed.muddebihal@linux.intel.com>

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


  parent reply	other threads:[~2022-05-19 22:13 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-05-19 22:12 [PATCH 0/3] Fix kernel-doc warnings dfl files Basheer Ahmed Muddebihal
2022-05-19 22:12 ` [PATCH 1/3] fpga: dfl: Fix kernel-doc warning in dfl.h for revision Basheer Ahmed Muddebihal
2022-05-28 10:45   ` Xu Yilun
2022-05-19 22:12 ` Basheer Ahmed Muddebihal [this message]
2022-05-28 10:49   ` [PATCH 2/3] fpga: dfl: Fix kernel-doc warnings in include/linux/dfl.h Xu Yilun
2022-05-19 22:12 ` [PATCH 3/3] fpga: dfl: Fix kernel-doc warnings in drivers/fpga/dfl.c Basheer Ahmed Muddebihal

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=20220519221249.858873-3-basheer.ahmed.muddebihal@linux.intel.com \
    --to=basheer.ahmed.muddebihal@linux.intel.com \
    --cc=hao.wu@intel.com \
    --cc=linux-fpga@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=marpagan@redhat.com \
    --cc=matthew.gerlach@linux.intel.com \
    --cc=mdf@kernel.org \
    --cc=tianfei.zhang@intel.com \
    --cc=trix@redhat.com \
    --cc=yilun.xu@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;
as well as URLs for NNTP newsgroup(s).