Commit bb11b4eb authored by Lee Jones's avatar Lee Jones Committed by Greg Kroah-Hartman

misc: mic: scif: scif_fence: Fix a bunch of different documentation issues

Firstly add missing descriptions for every use of 'scifdev', then
correct incorrect formatting of existing function argument descriptions
changing to the expected format of '@.*: ', finally add missing
description for function argument 'mark'.

Fixes the following W=1 warnings:

 drivers/misc/mic/scif/scif_fence.c:19: warning: Function parameter or member 'scifdev' not described in 'scif_recv_mark'
 drivers/misc/mic/scif/scif_fence.c:41: warning: Function parameter or member 'scifdev' not described in 'scif_recv_mark_resp'
 drivers/misc/mic/scif/scif_fence.c:64: warning: Function parameter or member 'scifdev' not described in 'scif_recv_wait'
 drivers/misc/mic/scif/scif_fence.c:101: warning: Function parameter or member 'scifdev' not described in 'scif_recv_wait_resp'
 drivers/misc/mic/scif/scif_fence.c:122: warning: Function parameter or member 'scifdev' not described in 'scif_recv_sig_local'
 drivers/misc/mic/scif/scif_fence.c:143: warning: Function parameter or member 'scifdev' not described in 'scif_recv_sig_remote'
 drivers/misc/mic/scif/scif_fence.c:164: warning: Function parameter or member 'scifdev' not described in 'scif_recv_sig_resp'
 drivers/misc/mic/scif/scif_fence.c:515: warning: Function parameter or member 'epd' not described in 'scif_send_fence_signal'
 drivers/misc/mic/scif/scif_fence.c:515: warning: Function parameter or member 'roff' not described in 'scif_send_fence_signal'
 drivers/misc/mic/scif/scif_fence.c:515: warning: Function parameter or member 'rval' not described in 'scif_send_fence_signal'
 drivers/misc/mic/scif/scif_fence.c:515: warning: Function parameter or member 'loff' not described in 'scif_send_fence_signal'
 drivers/misc/mic/scif/scif_fence.c:515: warning: Function parameter or member 'lval' not described in 'scif_send_fence_signal'
 drivers/misc/mic/scif/scif_fence.c:515: warning: Function parameter or member 'flags' not described in 'scif_send_fence_signal'

Cc: Sudeep Dutt <sudeep.dutt@intel.com>
Cc: Ashutosh Dixit <ashutosh.dixit@intel.com>
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20200701083118.45744-25-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 31c68981
...@@ -11,6 +11,7 @@ ...@@ -11,6 +11,7 @@
/** /**
* scif_recv_mark: Handle SCIF_MARK request * scif_recv_mark: Handle SCIF_MARK request
* @scifdev: SCIF device
* @msg: Interrupt message * @msg: Interrupt message
* *
* The peer has requested a mark. * The peer has requested a mark.
...@@ -33,6 +34,7 @@ void scif_recv_mark(struct scif_dev *scifdev, struct scifmsg *msg) ...@@ -33,6 +34,7 @@ void scif_recv_mark(struct scif_dev *scifdev, struct scifmsg *msg)
/** /**
* scif_recv_mark_resp: Handle SCIF_MARK_(N)ACK messages. * scif_recv_mark_resp: Handle SCIF_MARK_(N)ACK messages.
* @scifdev: SCIF device
* @msg: Interrupt message * @msg: Interrupt message
* *
* The peer has responded to a SCIF_MARK message. * The peer has responded to a SCIF_MARK message.
...@@ -56,6 +58,7 @@ void scif_recv_mark_resp(struct scif_dev *scifdev, struct scifmsg *msg) ...@@ -56,6 +58,7 @@ void scif_recv_mark_resp(struct scif_dev *scifdev, struct scifmsg *msg)
/** /**
* scif_recv_wait: Handle SCIF_WAIT request * scif_recv_wait: Handle SCIF_WAIT request
* @scifdev: SCIF device
* @msg: Interrupt message * @msg: Interrupt message
* *
* The peer has requested waiting on a fence. * The peer has requested waiting on a fence.
...@@ -93,6 +96,7 @@ void scif_recv_wait(struct scif_dev *scifdev, struct scifmsg *msg) ...@@ -93,6 +96,7 @@ void scif_recv_wait(struct scif_dev *scifdev, struct scifmsg *msg)
/** /**
* scif_recv_wait_resp: Handle SCIF_WAIT_(N)ACK messages. * scif_recv_wait_resp: Handle SCIF_WAIT_(N)ACK messages.
* @scifdev: SCIF device
* @msg: Interrupt message * @msg: Interrupt message
* *
* The peer has responded to a SCIF_WAIT message. * The peer has responded to a SCIF_WAIT message.
...@@ -114,6 +118,7 @@ void scif_recv_wait_resp(struct scif_dev *scifdev, struct scifmsg *msg) ...@@ -114,6 +118,7 @@ void scif_recv_wait_resp(struct scif_dev *scifdev, struct scifmsg *msg)
/** /**
* scif_recv_sig_local: Handle SCIF_SIG_LOCAL request * scif_recv_sig_local: Handle SCIF_SIG_LOCAL request
* @scifdev: SCIF device
* @msg: Interrupt message * @msg: Interrupt message
* *
* The peer has requested a signal on a local offset. * The peer has requested a signal on a local offset.
...@@ -135,6 +140,7 @@ void scif_recv_sig_local(struct scif_dev *scifdev, struct scifmsg *msg) ...@@ -135,6 +140,7 @@ void scif_recv_sig_local(struct scif_dev *scifdev, struct scifmsg *msg)
/** /**
* scif_recv_sig_remote: Handle SCIF_SIGNAL_REMOTE request * scif_recv_sig_remote: Handle SCIF_SIGNAL_REMOTE request
* @scifdev: SCIF device
* @msg: Interrupt message * @msg: Interrupt message
* *
* The peer has requested a signal on a remote offset. * The peer has requested a signal on a remote offset.
...@@ -156,6 +162,7 @@ void scif_recv_sig_remote(struct scif_dev *scifdev, struct scifmsg *msg) ...@@ -156,6 +162,7 @@ void scif_recv_sig_remote(struct scif_dev *scifdev, struct scifmsg *msg)
/** /**
* scif_recv_sig_resp: Handle SCIF_SIG_(N)ACK messages. * scif_recv_sig_resp: Handle SCIF_SIG_(N)ACK messages.
* @scifdev: SCIF device
* @msg: Interrupt message * @msg: Interrupt message
* *
* The peer has responded to a signal request. * The peer has responded to a signal request.
...@@ -280,12 +287,12 @@ static int _scif_prog_signal(scif_epd_t epd, dma_addr_t dst, u64 val) ...@@ -280,12 +287,12 @@ static int _scif_prog_signal(scif_epd_t epd, dma_addr_t dst, u64 val)
return err; return err;
} }
/* /**
* scif_prog_signal: * scif_prog_signal:
* @epd - Endpoint Descriptor * @epd: Endpoint Descriptor
* @offset - registered address to write @val to * @offset: registered address to write @val to
* @val - Value to be written at @offset * @val: Value to be written at @offset
* @type - Type of the window. * @type: Type of the window.
* *
* Arrange to write a value to the registered offset after ensuring that the * Arrange to write a value to the registered offset after ensuring that the
* offset provided is indeed valid. * offset provided is indeed valid.
...@@ -501,12 +508,12 @@ static int _scif_send_fence_signal_wait(struct scif_endpt *ep, ...@@ -501,12 +508,12 @@ static int _scif_send_fence_signal_wait(struct scif_endpt *ep,
/** /**
* scif_send_fence_signal: * scif_send_fence_signal:
* @epd - endpoint descriptor * @epd: endpoint descriptor
* @loff - local offset * @loff: local offset
* @lval - local value to write to loffset * @lval: local value to write to loffset
* @roff - remote offset * @roff: remote offset
* @rval - remote value to write to roffset * @rval: remote value to write to roffset
* @flags - flags * @flags: flags
* *
* Sends a remote fence signal request * Sends a remote fence signal request
*/ */
...@@ -577,10 +584,11 @@ static void scif_fence_mark_cb(void *arg) ...@@ -577,10 +584,11 @@ static void scif_fence_mark_cb(void *arg)
atomic_dec(&ep->rma_info.fence_refcount); atomic_dec(&ep->rma_info.fence_refcount);
} }
/* /**
* _scif_fence_mark: * _scif_fence_mark:
* @epd: endpoint descriptor
* @mark: DMA mark to set-up
* *
* @epd - endpoint descriptor
* Set up a mark for this endpoint and return the value of the mark. * Set up a mark for this endpoint and return the value of the mark.
*/ */
int _scif_fence_mark(scif_epd_t epd, int *mark) int _scif_fence_mark(scif_epd_t epd, int *mark)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment