aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/scsi
diff options
context:
space:
mode:
authorBart Van Assche <bvanassche@acm.org>2014-01-13 06:39:35 -0500
committerRoland Dreier <roland@purestorage.com>2014-01-21 13:46:17 -0500
commit0c7f82189d2249153ee302fe4d02de15f165d220 (patch)
tree97ccc0501697498bb6fd8388c46df5295aa4071e /drivers/scsi
parent31b90347dc9fb7649a8dc3ffefa52771ac30e10b (diff)
scsi_transport_srp: Fix kernel-doc warnings
The following command has been used to verify that the kernel-doc tool no longer complains about undocumented fields: scripts/kernel-doc -html drivers/scsi/scsi_transport_srp.c \ include/scsi/scsi_transport_srp.h >srp-transport-doc.html Signed-off-by: Bart Van Assche <bvanassche@acm.org> Acked-by: Sebastian Riemer <sebastian.riemer@profitbricks.com> Acked-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Roland Dreier <roland@purestorage.com>
Diffstat (limited to 'drivers/scsi')
-rw-r--r--drivers/scsi/scsi_transport_srp.c12
1 files changed, 12 insertions, 0 deletions
diff --git a/drivers/scsi/scsi_transport_srp.c b/drivers/scsi/scsi_transport_srp.c
index a349d44c4c36..d47ffc8d3e43 100644
--- a/drivers/scsi/scsi_transport_srp.c
+++ b/drivers/scsi/scsi_transport_srp.c
@@ -64,6 +64,9 @@ static inline struct Scsi_Host *rport_to_shost(struct srp_rport *r)
64 64
65/** 65/**
66 * srp_tmo_valid() - check timeout combination validity 66 * srp_tmo_valid() - check timeout combination validity
67 * @reconnect_delay: Reconnect delay in seconds.
68 * @fast_io_fail_tmo: Fast I/O fail timeout in seconds.
69 * @dev_loss_tmo: Device loss timeout in seconds.
67 * 70 *
68 * The combination of the timeout parameters must be such that SCSI commands 71 * The combination of the timeout parameters must be such that SCSI commands
69 * are finished in a reasonable time. Hence do not allow the fast I/O fail 72 * are finished in a reasonable time. Hence do not allow the fast I/O fail
@@ -372,6 +375,7 @@ invalid:
372 375
373/** 376/**
374 * srp_reconnect_work() - reconnect and schedule a new attempt if necessary 377 * srp_reconnect_work() - reconnect and schedule a new attempt if necessary
378 * @work: Work structure used for scheduling this operation.
375 */ 379 */
376static void srp_reconnect_work(struct work_struct *work) 380static void srp_reconnect_work(struct work_struct *work)
377{ 381{
@@ -412,6 +416,7 @@ static void __rport_fail_io_fast(struct srp_rport *rport)
412 416
413/** 417/**
414 * rport_fast_io_fail_timedout() - fast I/O failure timeout handler 418 * rport_fast_io_fail_timedout() - fast I/O failure timeout handler
419 * @work: Work structure used for scheduling this operation.
415 */ 420 */
416static void rport_fast_io_fail_timedout(struct work_struct *work) 421static void rport_fast_io_fail_timedout(struct work_struct *work)
417{ 422{
@@ -430,6 +435,7 @@ static void rport_fast_io_fail_timedout(struct work_struct *work)
430 435
431/** 436/**
432 * rport_dev_loss_timedout() - device loss timeout handler 437 * rport_dev_loss_timedout() - device loss timeout handler
438 * @work: Work structure used for scheduling this operation.
433 */ 439 */
434static void rport_dev_loss_timedout(struct work_struct *work) 440static void rport_dev_loss_timedout(struct work_struct *work)
435{ 441{
@@ -484,6 +490,7 @@ static void __srp_start_tl_fail_timers(struct srp_rport *rport)
484 490
485/** 491/**
486 * srp_start_tl_fail_timers() - start the transport layer failure timers 492 * srp_start_tl_fail_timers() - start the transport layer failure timers
493 * @rport: SRP target port.
487 * 494 *
488 * Start the transport layer fast I/O failure and device loss timers. Do not 495 * Start the transport layer fast I/O failure and device loss timers. Do not
489 * modify a timer that was already started. 496 * modify a timer that was already started.
@@ -498,6 +505,7 @@ EXPORT_SYMBOL(srp_start_tl_fail_timers);
498 505
499/** 506/**
500 * scsi_request_fn_active() - number of kernel threads inside scsi_request_fn() 507 * scsi_request_fn_active() - number of kernel threads inside scsi_request_fn()
508 * @shost: SCSI host for which to count the number of scsi_request_fn() callers.
501 */ 509 */
502static int scsi_request_fn_active(struct Scsi_Host *shost) 510static int scsi_request_fn_active(struct Scsi_Host *shost)
503{ 511{
@@ -518,6 +526,7 @@ static int scsi_request_fn_active(struct Scsi_Host *shost)
518 526
519/** 527/**
520 * srp_reconnect_rport() - reconnect to an SRP target port 528 * srp_reconnect_rport() - reconnect to an SRP target port
529 * @rport: SRP target port.
521 * 530 *
522 * Blocks SCSI command queueing before invoking reconnect() such that 531 * Blocks SCSI command queueing before invoking reconnect() such that
523 * queuecommand() won't be invoked concurrently with reconnect() from outside 532 * queuecommand() won't be invoked concurrently with reconnect() from outside
@@ -595,6 +604,7 @@ EXPORT_SYMBOL(srp_reconnect_rport);
595 604
596/** 605/**
597 * srp_timed_out() - SRP transport intercept of the SCSI timeout EH 606 * srp_timed_out() - SRP transport intercept of the SCSI timeout EH
607 * @scmd: SCSI command.
598 * 608 *
599 * If a timeout occurs while an rport is in the blocked state, ask the SCSI 609 * If a timeout occurs while an rport is in the blocked state, ask the SCSI
600 * EH to continue waiting (BLK_EH_RESET_TIMER). Otherwise let the SCSI core 610 * EH to continue waiting (BLK_EH_RESET_TIMER). Otherwise let the SCSI core
@@ -666,6 +676,7 @@ static int srp_host_match(struct attribute_container *cont, struct device *dev)
666 676
667/** 677/**
668 * srp_rport_get() - increment rport reference count 678 * srp_rport_get() - increment rport reference count
679 * @rport: SRP target port.
669 */ 680 */
670void srp_rport_get(struct srp_rport *rport) 681void srp_rport_get(struct srp_rport *rport)
671{ 682{
@@ -675,6 +686,7 @@ EXPORT_SYMBOL(srp_rport_get);
675 686
676/** 687/**
677 * srp_rport_put() - decrement rport reference count 688 * srp_rport_put() - decrement rport reference count
689 * @rport: SRP target port.
678 */ 690 */
679void srp_rport_put(struct srp_rport *rport) 691void srp_rport_put(struct srp_rport *rport)
680{ 692{