From: Lee Jones <lee.jones@linaro.org>
To: arnd@arndb.de, gregkh@linuxfoundation.org
Cc: Ashutosh Dixit <ashutosh.dixit@intel.com>,
Lee Jones <lee.jones@linaro.org>,
linux-kernel@vger.kernel.org,
linux-arm-kernel@lists.infradead.org,
Sudeep Dutt <sudeep.dutt@intel.com>
Subject: [PATCH 25/30] misc: mic: scif: scif_rma: Repair a bunch of kerneldoc issues
Date: Tue, 30 Jun 2020 14:51:05 +0100 [thread overview]
Message-ID: <20200630135110.2236389-26-lee.jones@linaro.org> (raw)
In-Reply-To: <20200630135110.2236389-1-lee.jones@linaro.org>
Firstly, for some reason documentation of all 'scifdev' arguments
are missing, so apply those. Also remove 2 descriptions of 'ep'
which appear to document non-existent function arguments.
drivers/misc/mic/scif/scif_rma.c:468: warning: Function parameter or member 'scifdev' not described in 'scif_create_remote_window'
drivers/misc/mic/scif/scif_rma.c:468: warning: Excess function parameter 'ep' description in 'scif_create_remote_window'
drivers/misc/mic/scif/scif_rma.c:510: warning: Excess function parameter 'ep' description in 'scif_destroy_remote_window'
drivers/misc/mic/scif/scif_rma.c:1045: warning: Function parameter or member 'scifdev' not described in 'scif_alloc_req'
drivers/misc/mic/scif/scif_rma.c:1080: warning: Function parameter or member 'scifdev' not described in 'scif_alloc_gnt_rej'
drivers/misc/mic/scif/scif_rma.c:1104: warning: Function parameter or member 'scifdev' not described in 'scif_free_virt'
drivers/misc/mic/scif/scif_rma.c:1142: warning: Function parameter or member 'scifdev' not described in 'scif_recv_reg'
drivers/misc/mic/scif/scif_rma.c:1178: warning: Function parameter or member 'scifdev' not described in 'scif_recv_unreg'
drivers/misc/mic/scif/scif_rma.c:1243: warning: Function parameter or member 'scifdev' not described in 'scif_recv_reg_ack'
drivers/misc/mic/scif/scif_rma.c:1262: warning: Function parameter or member 'scifdev' not described in 'scif_recv_reg_nack'
drivers/misc/mic/scif/scif_rma.c:1280: warning: Function parameter or member 'scifdev' not described in 'scif_recv_unreg_ack'
drivers/misc/mic/scif/scif_rma.c:1299: warning: Function parameter or member 'scifdev' not described in 'scif_recv_unreg_nack'
Cc: Sudeep Dutt <sudeep.dutt@intel.com>
Cc: Ashutosh Dixit <ashutosh.dixit@intel.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
drivers/misc/mic/scif/scif_rma.c | 12 ++++++++++--
1 file changed, 10 insertions(+), 2 deletions(-)
diff --git a/drivers/misc/mic/scif/scif_rma.c b/drivers/misc/mic/scif/scif_rma.c
index 406cd5abfa726..de8f61efaef5c 100644
--- a/drivers/misc/mic/scif/scif_rma.c
+++ b/drivers/misc/mic/scif/scif_rma.c
@@ -458,7 +458,7 @@ static void scif_destroy_remote_lookup(struct scif_dev *remote_dev,
/**
* scif_create_remote_window:
- * @ep: end point
+ * @scifdev: SCIF device
* @nr_pages: number of pages in window
*
* Allocate and prepare a remote registration window.
@@ -500,7 +500,6 @@ scif_create_remote_window(struct scif_dev *scifdev, int nr_pages)
/**
* scif_destroy_remote_window:
- * @ep: end point
* @window: remote registration window
*
* Deallocate resources for remote window.
@@ -1037,6 +1036,7 @@ void scif_free_window_offset(struct scif_endpt *ep,
/**
* scif_alloc_req: Respond to SCIF_ALLOC_REQ interrupt message
+ * @scifdev: SCIF device
* @msg: Interrupt message
*
* Remote side is requesting a memory allocation.
@@ -1072,6 +1072,7 @@ void scif_alloc_req(struct scif_dev *scifdev, struct scifmsg *msg)
/**
* scif_alloc_gnt_rej: Respond to SCIF_ALLOC_GNT/REJ interrupt message
+ * @scifdev: SCIF device
* @msg: Interrupt message
*
* Remote side responded to a memory allocation.
@@ -1096,6 +1097,7 @@ void scif_alloc_gnt_rej(struct scif_dev *scifdev, struct scifmsg *msg)
/**
* scif_free_virt: Respond to SCIF_FREE_VIRT interrupt message
+ * @scifdev: SCIF device
* @msg: Interrupt message
*
* Free up memory kmalloc'd earlier.
@@ -1134,6 +1136,7 @@ scif_fixup_aper_base(struct scif_dev *dev, struct scif_window *window)
/**
* scif_recv_reg: Respond to SCIF_REGISTER interrupt message
+ * @scifdev: SCIF device
* @msg: Interrupt message
*
* Update remote window list with a new registered window.
@@ -1170,6 +1173,7 @@ void scif_recv_reg(struct scif_dev *scifdev, struct scifmsg *msg)
/**
* scif_recv_unreg: Respond to SCIF_UNREGISTER interrupt message
+ * @scifdev: SCIF device
* @msg: Interrupt message
*
* Remove window from remote registration list;
@@ -1235,6 +1239,7 @@ void scif_recv_unreg(struct scif_dev *scifdev, struct scifmsg *msg)
/**
* scif_recv_reg_ack: Respond to SCIF_REGISTER_ACK interrupt message
+ * @scifdev: SCIF device
* @msg: Interrupt message
*
* Wake up the window waiting to complete registration.
@@ -1253,6 +1258,7 @@ void scif_recv_reg_ack(struct scif_dev *scifdev, struct scifmsg *msg)
/**
* scif_recv_reg_nack: Respond to SCIF_REGISTER_NACK interrupt message
+ * @scifdev: SCIF device
* @msg: Interrupt message
*
* Wake up the window waiting to inform it that registration
@@ -1272,6 +1278,7 @@ void scif_recv_reg_nack(struct scif_dev *scifdev, struct scifmsg *msg)
/**
* scif_recv_unreg_ack: Respond to SCIF_UNREGISTER_ACK interrupt message
+ * @scifdev: SCIF device
* @msg: Interrupt message
*
* Wake up the window waiting to complete unregistration.
@@ -1290,6 +1297,7 @@ void scif_recv_unreg_ack(struct scif_dev *scifdev, struct scifmsg *msg)
/**
* scif_recv_unreg_nack: Respond to SCIF_UNREGISTER_NACK interrupt message
+ * @scifdev: SCIF device
* @msg: Interrupt message
*
* Wake up the window waiting to inform it that unregistration
--
2.25.1
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
next prev parent reply other threads:[~2020-06-30 14:00 UTC|newest]
Thread overview: 33+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-06-30 13:50 [PATCH 00/30] Last batch of patches to clean up Misc Lee Jones
2020-06-30 13:50 ` [PATCH 01/30] misc: genwqe: card_ddcb: Fix a variety of kerneldoc issues Lee Jones
2020-06-30 13:50 ` [PATCH 02/30] misc: genwqe: card_sysfs: Demote function/file headers from kerneldoc Lee Jones
2020-06-30 13:50 ` [PATCH 03/30] misc: genwqe: card_debugfs: Demote file header " Lee Jones
2020-06-30 13:50 ` [PATCH 04/30] misc: sgi-xp: xp_main: Staticify local functions xp_init() and xp_exit() Lee Jones
2020-07-01 17:09 ` Robin Holt
2020-06-30 13:50 ` [PATCH 05/30] misc: ibmasm: event: Demote function headers from kerneldoc Lee Jones
2020-06-30 13:50 ` [PATCH 06/30] misc: ibmasm: command: " Lee Jones
2020-06-30 13:50 ` [PATCH 07/30] misc: vmw_vmci_defs: 'struct vmci_handle VMCI_ANON_SRC_HANDLE' cannot be static Lee Jones
2020-06-30 22:58 ` kernel test robot
2020-06-30 13:50 ` [PATCH 08/30] misc: ibmasm: r_heartbeat: Demote function headers from kerneldoc Lee Jones
2020-06-30 13:50 ` [PATCH 09/30] misc: mic: host: mic_x100: Move declaration of mic_x100_intr_init[] into c-file Lee Jones
2020-06-30 13:50 ` [PATCH 10/30] misc: ibmasm: dot_command: Demote function headers from kerneldoc Lee Jones
2020-06-30 13:50 ` [PATCH 11/30] misc: mic: host: mic_intr: Properly document function arguments Lee Jones
2020-06-30 13:50 ` [PATCH 12/30] misc: mic: host: mic_x100: Add missing descriptions to kerneldoc headers Lee Jones
2020-06-30 13:50 ` [PATCH 13/30] misc: mic: card: mic_debugfs: Demote function headers from kerneldoc Lee Jones
2020-06-30 13:50 ` [PATCH 14/30] misc: mic: host: " Lee Jones
2020-06-30 13:50 ` [PATCH 15/30] misc: mic: cosm: cosm_main: Document 'force' function argument Lee Jones
2020-06-30 13:50 ` [PATCH 16/30] misc: mic: scif: scif_ports: Fix copy 'n' paste error Lee Jones
2020-06-30 13:50 ` [PATCH 17/30] misc: mic: cosm: cosm_debugfs: Demote function headers from kerneldoc Lee Jones
2020-06-30 13:50 ` [PATCH 18/30] misc: mic: scif: scif_api: Remove set but unused variable 'read_size' Lee Jones
2020-06-30 13:50 ` [PATCH 19/30] misc: mic: scif: scif_api: Demote scif_accept() function header Lee Jones
2020-06-30 13:51 ` [PATCH 20/30] misc: mic: scif: scif_epd: Describe missing 'scifdev' argument(s) Lee Jones
2020-06-30 13:51 ` [PATCH 21/30] misc: mic: scif: scif_nodeqp: Fix a bunch of kerneldoc issues Lee Jones
2020-06-30 13:51 ` [PATCH 22/30] misc: mic: scif: scif_nm: Supply various kerneldoc fix-ups Lee Jones
2020-06-30 13:51 ` [PATCH 23/30] misc: mic: scif: scif_dma: Fix a couple of kerneldoc issues Lee Jones
2020-06-30 13:51 ` [PATCH 24/30] misc: mic: scif: scif_fence: Fix a bunch of different documentation issues Lee Jones
2020-06-30 13:51 ` Lee Jones [this message]
2020-06-30 13:51 ` [PATCH 26/30] misc: eeprom: at24: Tell the compiler that ACPI functions may not be used Lee Jones
2020-06-30 13:51 ` [PATCH 27/30] misc: cxl: hcalls: Demote half-assed kerneldoc attempt Lee Jones
2020-06-30 13:51 ` [PATCH 28/30] misc: ocxl: config: Provide correct formatting to function headers Lee Jones
2020-06-30 13:51 ` [PATCH 29/30] misc: ibmvmc: Repair ill-named function argument descriptions Lee Jones
2020-06-30 13:51 ` [PATCH 30/30] misc: cxl: flash: Remove unused pointer Lee Jones
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=20200630135110.2236389-26-lee.jones@linaro.org \
--to=lee.jones@linaro.org \
--cc=arnd@arndb.de \
--cc=ashutosh.dixit@intel.com \
--cc=gregkh@linuxfoundation.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=sudeep.dutt@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).