diff options
author | Rob Landley <rob@landley.net> | 2007-11-03 14:30:39 -0400 |
---|---|---|
committer | James Bottomley <James.Bottomley@HansenPartnership.com> | 2008-01-11 19:22:40 -0500 |
commit | eb44820c28bc9a042e1157b41c677018a8fdfc74 (patch) | |
tree | de027b3cd40533488805ef7ee8156f077cd2b7e5 /drivers/scsi/scsi_transport_iscsi.c | |
parent | 3f48985823001c89c9bd5c5e57cc07530578dfcc (diff) |
[SCSI] Add Documentation and integrate into docbook build
Add Documentation/DocBook/scsi_midlayer.tmpl, add to Makefile, and update
lots of kerneldoc comments in drivers/scsi/*.
Updated with comments from Stefan Richter, Stephen M. Cameron,
James Bottomley and Randy Dunlap.
Signed-off-by: Rob Landley <rob@landley.net>
Signed-off-by: James Bottomley <James.Bottomley@HansenPartnership.com>
Diffstat (limited to 'drivers/scsi/scsi_transport_iscsi.c')
-rw-r--r-- | drivers/scsi/scsi_transport_iscsi.c | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/drivers/scsi/scsi_transport_iscsi.c b/drivers/scsi/scsi_transport_iscsi.c index 5428d15f23c6..cb48b80c0865 100644 --- a/drivers/scsi/scsi_transport_iscsi.c +++ b/drivers/scsi/scsi_transport_iscsi.c | |||
@@ -328,9 +328,10 @@ EXPORT_SYMBOL_GPL(iscsi_add_session); | |||
328 | * iscsi_create_session - create iscsi class session | 328 | * iscsi_create_session - create iscsi class session |
329 | * @shost: scsi host | 329 | * @shost: scsi host |
330 | * @transport: iscsi transport | 330 | * @transport: iscsi transport |
331 | * @target_id: which target | ||
331 | * | 332 | * |
332 | * This can be called from a LLD or iscsi_transport. | 333 | * This can be called from a LLD or iscsi_transport. |
333 | **/ | 334 | */ |
334 | struct iscsi_cls_session * | 335 | struct iscsi_cls_session * |
335 | iscsi_create_session(struct Scsi_Host *shost, | 336 | iscsi_create_session(struct Scsi_Host *shost, |
336 | struct iscsi_transport *transport, | 337 | struct iscsi_transport *transport, |
@@ -382,7 +383,7 @@ EXPORT_SYMBOL_GPL(iscsi_free_session); | |||
382 | * | 383 | * |
383 | * Can be called by a LLD or iscsi_transport. There must not be | 384 | * Can be called by a LLD or iscsi_transport. There must not be |
384 | * any running connections. | 385 | * any running connections. |
385 | **/ | 386 | */ |
386 | int iscsi_destroy_session(struct iscsi_cls_session *session) | 387 | int iscsi_destroy_session(struct iscsi_cls_session *session) |
387 | { | 388 | { |
388 | iscsi_remove_session(session); | 389 | iscsi_remove_session(session); |
@@ -418,7 +419,7 @@ static int iscsi_is_conn_dev(const struct device *dev) | |||
418 | * for software iscsi we could be trying to preallocate a connection struct | 419 | * for software iscsi we could be trying to preallocate a connection struct |
419 | * in which case there could be two connection structs and cid would be | 420 | * in which case there could be two connection structs and cid would be |
420 | * non-zero. | 421 | * non-zero. |
421 | **/ | 422 | */ |
422 | struct iscsi_cls_conn * | 423 | struct iscsi_cls_conn * |
423 | iscsi_create_conn(struct iscsi_cls_session *session, uint32_t cid) | 424 | iscsi_create_conn(struct iscsi_cls_session *session, uint32_t cid) |
424 | { | 425 | { |
@@ -465,10 +466,10 @@ EXPORT_SYMBOL_GPL(iscsi_create_conn); | |||
465 | 466 | ||
466 | /** | 467 | /** |
467 | * iscsi_destroy_conn - destroy iscsi class connection | 468 | * iscsi_destroy_conn - destroy iscsi class connection |
468 | * @session: iscsi cls session | 469 | * @conn: iscsi cls session |
469 | * | 470 | * |
470 | * This can be called from a LLD or iscsi_transport. | 471 | * This can be called from an LLD or iscsi_transport. |
471 | **/ | 472 | */ |
472 | int iscsi_destroy_conn(struct iscsi_cls_conn *conn) | 473 | int iscsi_destroy_conn(struct iscsi_cls_conn *conn) |
473 | { | 474 | { |
474 | transport_unregister_device(&conn->dev); | 475 | transport_unregister_device(&conn->dev); |
@@ -690,7 +691,7 @@ iscsi_if_get_stats(struct iscsi_transport *transport, struct nlmsghdr *nlh) | |||
690 | * | 691 | * |
691 | * This is called by HW iscsi LLDs to notify userpsace that its HW has | 692 | * This is called by HW iscsi LLDs to notify userpsace that its HW has |
692 | * removed a session. | 693 | * removed a session. |
693 | **/ | 694 | */ |
694 | int iscsi_if_destroy_session_done(struct iscsi_cls_conn *conn) | 695 | int iscsi_if_destroy_session_done(struct iscsi_cls_conn *conn) |
695 | { | 696 | { |
696 | struct iscsi_internal *priv; | 697 | struct iscsi_internal *priv; |
@@ -751,7 +752,7 @@ EXPORT_SYMBOL_GPL(iscsi_if_destroy_session_done); | |||
751 | * | 752 | * |
752 | * This is called by HW iscsi LLDs to notify userpsace that its HW has | 753 | * This is called by HW iscsi LLDs to notify userpsace that its HW has |
753 | * created a session or a existing session is back in the logged in state. | 754 | * created a session or a existing session is back in the logged in state. |
754 | **/ | 755 | */ |
755 | int iscsi_if_create_session_done(struct iscsi_cls_conn *conn) | 756 | int iscsi_if_create_session_done(struct iscsi_cls_conn *conn) |
756 | { | 757 | { |
757 | struct iscsi_internal *priv; | 758 | struct iscsi_internal *priv; |