[src/trunk]: src/share/man/man4 Document the `sc' SCSI driver.

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

details:   https://anonhg.NetBSD.org/src/rev/b7895c232287
branches:  trunk
changeset: 511877:b7895c232287
user:      fredette <fredette%NetBSD.org@localhost>
date:      Thu Jun 28 21:12:01 2001 +0000

description:
Document the `sc' SCSI driver.

diffstat:

 share/man/man4/Makefile |    4 +-
 share/man/man4/sc.4     |  136 ++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 138 insertions(+), 2 deletions(-)

diffs (158 lines):

diff -r e7ea5a272f00 -r b7895c232287 share/man/man4/Makefile
--- a/share/man/man4/Makefile   Thu Jun 28 21:11:34 2001 +0000
+++ b/share/man/man4/Makefile   Thu Jun 28 21:12:01 2001 +0000
@@ -1,4 +1,4 @@
-#      $NetBSD: Makefile,v 1.206 2001/06/19 23:58:16 thorpej Exp $
+#      $NetBSD: Makefile,v 1.207 2001/06/28 21:12:01 fredette Exp $
 #      @(#)Makefile    8.1 (Berkeley) 6/18/93
 
 MAN=   adv.4 adw.4 ahb.4 ahc.4 an.4 aria.4 atalk.4 audio.4 auich.4 auvia.4 \
@@ -47,7 +47,7 @@
 MAN+=  dtide.4 ea.4 eb.4 hcide.4
 
 # machine-independent VME devices
-MAN+=  si.4
+MAN+=  sc.4 si.4
 
 # IPv6/IPsec
 MAN+=  faith.4 gif.4 inet6.4 icmp6.4 ip6.4 ipsec.4 stf.4
diff -r e7ea5a272f00 -r b7895c232287 share/man/man4/sc.4
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man4/sc.4       Thu Jun 28 21:12:01 2001 +0000
@@ -0,0 +1,136 @@
+.\"     $NetBSD: sc.4,v 1.1 2001/06/28 21:12:02 fredette Exp $
+.\"
+.\" written from a reading of config files and driver source code
+.\" Erik E. Fair <fair%netbsd.org@localhost>
+.\" Matt Fredette <fredette%netbsd.org@localhost>
+.Dd June 28, 2001
+.Dt SC 4
+.Os
+.Sh NAME
+.Nm sc
+.Nd Sun Sun-2 SCSI bus host adaptor driver
+.Sh SYNOPSIS
+.Ss sun2
+.Cd "sc0 at mbmem0 addr 0x80000 ipl 2"
+.Cd "sc1 at mbmem0 addr 0x84000 ipl 2"
+.Ss sun2 and sun4
+.Cd "sc0 at vme0 addr 0x200000 irq 2 vec 0x40"
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for the
+Sun Microsystems
+.Qq Sun-2
+.Tn SCSI
+Bus Controller chipset found on various 
+VME boards
+.Pq Sun part #s 501-1045, 501-1138, 501-1149, and 501-1167
+and on the
+.Qq Sun-2 SCSI/Serial
+.Pq Sun part # 501-1006
+Multibus board.
+.Pp
+All 
+versions of this driver can be configured with a
+.Em flags
+directive in the
+.Xr config 8
+file.
+The values are bits in a bitfield, and are interpreted as follows:
+.Pp
+.Bl -tag -offset indent -compact -width 0x000ff
+.It 0x0ff
+Set bit (1<<target) to disable
+.Tn SCSI
+parity checking
+.It 0x100
+Set this bit to disable
+.Tn DMA
+interrupts (poll)
+.It 0x200
+Set this bit to disable
+.Tn DMA
+entirely (use PIO)
+.El
+.Pp
+For example:
+.Qq flags 0x1ff
+would disable
+.Tn DMA
+interrupts, and disable parity checking for targets 0-7.
+The
+.Qq target
+is the
+.Tn SCSI
+ID number of a particular device on a particular
+.Tn SCSI
+bus.
+.Sh BUGS
+This 
+.Tn SCSI 
+chipset is rumored to have bugs in its handling of
+.Tn SCSI
+parity, therefore it is recommended that you disable parity
+on all 
+.Tn SCSI
+devices connected to this controller, and configure it with
+a
+0x0ff
+value for its
+.Em flags
+directive in the
+.Xr config 8
+file.
+.Pp
+This 
+chipset has no support for raising the
+.Tn ATN
+signal, so there is no way to ever schedule a
+.Tn MSG_OUT
+phase on the bus.  Currently, the driver will ultimately
+reset the bus if this phase is ever requested by the upper
+layer
+.Tn SCSI
+driver.
+.Pp
+This chipset has no support for
+.Tn SCSI
+disconnect/reselect.  This means that slow devices,
+such as tape drives, can hog, or
+.Qq lock up
+the SCSI bus.
+.Pp
+This driver has not been tested in combination with
+non-SCSI devices behind
+.Tn Emulex
+or
+.Tn Adaptec
+bridges, which are common in 
+.Tn Sun
+2s and in 
+.Tn Sun
+Shoebox-type configurations.
+These devices pre-date the
+.Tn SCSI-I
+spec, and might not behave the way the chipset code currently expects.
+.Sh SEE ALSO
+.Xr intro 4 ,
+.Xr scsi 4 ,
+.Xr sd 4 ,
+.Xr st 4 ,
+.Xr cd 4 ,
+.Xr ch 4  
+.Sh AUTHOR
+Matt Fredette,
+.Aq fredette%netbsd.org@localhost ,
+.br
+David Jones,
+.br
+Gordon Ross 
+.Aq gwr%netbsd.org@localhost ,
+.br
+Adam Glass
+.Aq glass%netbsd.org@localhost ,
+.br
+Jason R. Thorpe
+.Aq thorpej%netbsd.org@localhost .