Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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: Lee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20200701083118.45744-25-lee.jones@linaro.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Lee Jones and committed by
Greg Kroah-Hartman
bb11b4eb 31c68981

+21 -13
+21 -13
drivers/misc/mic/scif/scif_fence.c
··· 11 11 12 12 /** 13 13 * scif_recv_mark: Handle SCIF_MARK request 14 + * @scifdev: SCIF device 14 15 * @msg: Interrupt message 15 16 * 16 17 * The peer has requested a mark. ··· 34 33 35 34 /** 36 35 * scif_recv_mark_resp: Handle SCIF_MARK_(N)ACK messages. 36 + * @scifdev: SCIF device 37 37 * @msg: Interrupt message 38 38 * 39 39 * The peer has responded to a SCIF_MARK message. ··· 58 56 59 57 /** 60 58 * scif_recv_wait: Handle SCIF_WAIT request 59 + * @scifdev: SCIF device 61 60 * @msg: Interrupt message 62 61 * 63 62 * The peer has requested waiting on a fence. ··· 96 93 97 94 /** 98 95 * scif_recv_wait_resp: Handle SCIF_WAIT_(N)ACK messages. 96 + * @scifdev: SCIF device 99 97 * @msg: Interrupt message 100 98 * 101 99 * The peer has responded to a SCIF_WAIT message. ··· 118 114 119 115 /** 120 116 * scif_recv_sig_local: Handle SCIF_SIG_LOCAL request 117 + * @scifdev: SCIF device 121 118 * @msg: Interrupt message 122 119 * 123 120 * The peer has requested a signal on a local offset. ··· 140 135 141 136 /** 142 137 * scif_recv_sig_remote: Handle SCIF_SIGNAL_REMOTE request 138 + * @scifdev: SCIF device 143 139 * @msg: Interrupt message 144 140 * 145 141 * The peer has requested a signal on a remote offset. ··· 162 156 163 157 /** 164 158 * scif_recv_sig_resp: Handle SCIF_SIG_(N)ACK messages. 159 + * @scifdev: SCIF device 165 160 * @msg: Interrupt message 166 161 * 167 162 * The peer has responded to a signal request. ··· 287 280 return err; 288 281 } 289 282 290 - /* 283 + /** 291 284 * scif_prog_signal: 292 - * @epd - Endpoint Descriptor 293 - * @offset - registered address to write @val to 294 - * @val - Value to be written at @offset 295 - * @type - Type of the window. 285 + * @epd: Endpoint Descriptor 286 + * @offset: registered address to write @val to 287 + * @val: Value to be written at @offset 288 + * @type: Type of the window. 296 289 * 297 290 * Arrange to write a value to the registered offset after ensuring that the 298 291 * offset provided is indeed valid. ··· 508 501 509 502 /** 510 503 * scif_send_fence_signal: 511 - * @epd - endpoint descriptor 512 - * @loff - local offset 513 - * @lval - local value to write to loffset 514 - * @roff - remote offset 515 - * @rval - remote value to write to roffset 516 - * @flags - flags 504 + * @epd: endpoint descriptor 505 + * @loff: local offset 506 + * @lval: local value to write to loffset 507 + * @roff: remote offset 508 + * @rval: remote value to write to roffset 509 + * @flags: flags 517 510 * 518 511 * Sends a remote fence signal request 519 512 */ ··· 584 577 atomic_dec(&ep->rma_info.fence_refcount); 585 578 } 586 579 587 - /* 580 + /** 588 581 * _scif_fence_mark: 582 + * @epd: endpoint descriptor 583 + * @mark: DMA mark to set-up 589 584 * 590 - * @epd - endpoint descriptor 591 585 * Set up a mark for this endpoint and return the value of the mark. 592 586 */ 593 587 int _scif_fence_mark(scif_epd_t epd, int *mark)