Commit ff512a8b authored by Lee Jones's avatar Lee Jones Committed by Greg Kroah-Hartman
Browse files

misc: mic: scif: scif_rma: Repair a bunch of kerneldoc issues 



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: default avatarLee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20200701083118.45744-26-lee.jones@linaro.org


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent bb11b4eb

drivers/misc/mic/scif/scif_rma.c

+10 −2
Original line number Diff line number Diff line
@@ -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