[src/trunk]: src/sys/dev/ic Clarify cd_resid tag.

[mjacob <mjacob%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/3469b9b8a451
branches:  trunk
changeset: 482667:3469b9b8a451
user:      mjacob <mjacob%NetBSD.org@localhost>
date:      Sat Feb 19 01:50:03 2000 +0000

description:
Clarify cd_resid tag.

diffstat:

 sys/dev/ic/isp_tpublic.h |  14 ++++++--------
 1 files changed, 6 insertions(+), 8 deletions(-)

diffs (28 lines):

diff -r 96af2ed614e1 -r 3469b9b8a451 sys/dev/ic/isp_tpublic.h
--- a/sys/dev/ic/isp_tpublic.h  Sat Feb 19 01:49:47 2000 +0000
+++ b/sys/dev/ic/isp_tpublic.h  Sat Feb 19 01:50:03 2000 +0000
@@ -1,4 +1,4 @@
-/* $NetBSD: isp_tpublic.h,v 1.1 2000/02/12 02:23:13 mjacob Exp $ */
+/* $NetBSD: isp_tpublic.h,v 1.2 2000/02/19 01:50:03 mjacob Exp $ */
 /*
  * Qlogic ISP Host Adapter Public Target Interface Structures && Routines
  *---------------------------------------
@@ -129,13 +129,11 @@
  * data should be moved, the outer layer should set it to the amount
  * expected to be moved.
  *
- * The tag cd_resid is the total residual of data not transferred.
- * That is, cd_resid is set up, possibly by the MD layer when it
- * reads the expected data transfer length from an FCP CMND IU,
- * to be the total data amount expected to be moved over the life
- * of the command. As data is successfully moved, this value is
- * decreased. At the end of a command, any residual indicates the
- * number of bytes requested but not moved.
+ * The tag cd_resid should be the total residual of data not transferred.
+ * The outer layers need to set this at the begining of command processing
+ * to equal cd_totlen. As data is successfully moved, this value is decreased.
+ * At the end of a command, any nonzero residual indicates the number of bytes
+ * requested but not moved.
  *
  * The tag cd_xfrlen is the length of the currently active data transfer.
  * This allows several interations between any outside software and the