document si & sw drivers

share/man/man4/Makefile

@@ -1,4 +1,4 @@
-#	$NetBSD: Makefile,v 1.58 1998/05/06 19:02:28 augustss Exp $
+#	$NetBSD: Makefile,v 1.59 1998/05/07 10:55:21 fair Exp $
 #	@(#)Makefile	8.1 (Berkeley) 6/18/93
 
 MAN=	ahb.4 ahc.4 atalk.4 audio.4 bha.4 bpf.4 ccd.4 cd.4 clnp.4 cltp.4 \
@@ -15,10 +15,14 @@ MAN+=	eisa.4 isa.4 isapnp.4 pci.4 pcmcia.4
 MAN+=	aha.4 aic.4 ast.4 boca.4 cy.4 ec.4 eg.4 el.4 esp.4 gus.4 guspnp.4 \
 	iy.4 mcd.4 pss.4 rtfps.4 sb.4 sea.4 wds.4 we.4 wss.4 wt.4
 
+# macine-independent VME devices
+MAN+=	si.4
+
 MLINKS+=bha.4 bt.4
 MLINKS+=fd.4 stderr.4 fd.4 stdin.4 fd.4 stdout.4
 MLINKS+=fpa.4 fea.4
 MLINKS+=netintro.4 networking.4
+MLINKS+=si.4 sw.4
 
 SUBDIR=	man4.amiga man4.arm32 man4.atari man4.hp300 man4.i386 \
 	man4.mac68k man4.pc532 man4.pmax man4.sparc man4.sun3 \

share/man/man4/si.4

@@ -0,0 +1,189 @@
+.\" written from a reading of config files and driver source code
+.\" Erik E. Fair <fair@netbsd.org>
+.Dd May 7, 1998
+.Dt SI 4
+.Os NetBSD 
+.Sh NAME
+.Nm si ,
+.Nm sw
+.Nd NCR 5380 SCSI bus host adaptor driver
+.Sh SYNOPSIS
+.Ss sun3
+.Cd "si0 at obio0 addr 0x140000 ipl 2"
+.Ss sun3 and sun3x
+.Cd "si0 at vme2 addr 0x200000 ipl 2 vect 0x40"
+.Cd "si1 at vme2 addr 0x204000 ipl 2 vect 0x41"
+.Ss sun3/E
+.Cd "sebuf0 at vme2 addr 0x300000 ipl 2 vect 0x74 # and 0x75"
+.Cd "sebuf1 at vme2 addr 0x340000 ipl 2 vect 0x76 # and 0x77"
+.Cd "si* at sebuf?"
+.Ss sun4
+.Cd "si0 at vme0 addr 0x200000 pri 2 vec 0x40"
+.Ss sun4/100
+.Cd "sw0 at obio0 addr 0x0a000000 level 3"
+.Sh DESCRIPTION
+The
+.Nm
+and
+.Nm sw
+.Qq Tn SCSI Weird
+drivers provide support for the
+.Tn NCR
+5380
+.Tn SCSI
+Bus Controller (SBC) chip found on various Sun Microsystems
+.Tn CPU
+motherboards (obio), and on the
+.Qq Sun-3 VME SCSI
+.Pq Sun part # 501-1236
+board used in systems with
+.Tn VME
+bus.
+.Ss sun3 and sun3x
+The
+.Tn sun3
+and
+.Tn sun3x
+version 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 0x000ff
+Set bit (1<<target) to disable
+.Tn SCSI
+disconnect/reselect
+.It 0x0ff00
+Set bit (1<<(target+8)) to disable
+.Tn SCSI
+parity checking
+.It 0x10000
+Set this bit to disable
+.Tn DMA
+interrupts (poll)
+.It 0x20000
+Set this bit to disable
+.Tn DMA
+entirely (use PIO)
+.El
+.Pp
+For example:
+.Qq flags 0x1000f
+would disable
+.Tn DMA
+interrupts, and disable disconnect/reselect for targets 0-3.
+The
+.Qq target
+is the
+.Tn SCSI
+ID number of a particular device on a particular
+.Tn SCSI
+bus.
+.Ss sun4
+The
+.Tn sun4
+version of this driver can also 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 0x01
+.It 0x01
+Use
+.Tn DMA
+.Pq may be polled
+.It 0x02
+Use
+.Tn DMA
+completion interrupts
+.It 0x04
+Allow
+.Tn SCSI
+disconnect/reselect
+.El
+.Pp
+For example:
+.Qq flags 0x07
+would enable
+.Tn DMA ,
+interrupts, and reselect.
+By default,
+.Tn DMA
+is enabled in the
+.Tn sun4
+driver.
+.Sh BUGS
+The
+.Tn VME
+variant has a bit to enable or disable the
+.Tn DMA
+engine, but that bit also gates the interrupt line from the
+.Tn NCR5380
+.Pq !! .
+Therefore, in order to get any interrupt from the
+.Tn NCR5380 ,
+(i.e. for reselect) one must clear the
+.Tn DMA
+engine transfer count and then enable
+.Tn DMA .
+This has the further complication that you CAN NOT touch the
+.Tn NCR5380
+while the
+.Tn DMA
+enable bit is set, so we have to turn
+.Tn DMA
+back off before we even look at the
+.Tn NCR5380 .
+.Pp
+Support for the Sun 4/100
+.Nm sw
+.Qq Tn SCSI Weird
+is not complete.
+.Tn DMA
+works, but interrupts (and, thus, reselection) don't for reasons unknown.
+Further progress has halted pending the availability of a machine for testing.
+.Pp
+.Tn DMA ,
+.Tn DMA
+completion interrupts, and reselection work fine on a Sun 4/260 with modern
+.Tn SCSI-II
+disks attached.
+There have been reports of reselection failing on
+.Tn Sun
+Shoebox-type configurations where
+there are multiple non-SCSI devices behind
+.Tn Emulex
+or
+.Tn Adaptec
+bridges.
+These devices pre-date the
+.Tn SCSI-I
+spec, and might not behave the way the NCR5380 code expects.
+For this reason, only
+.Tn DMA
+is enabled by default in the
+.Tn sun4
+driver.
+.Sh SEE ALSO
+.Xr intro 4 ,
+.Xr scsi 4 ,
+.Xr sd 4 ,
+.Xr st 4 ,
+.Xr cd 4 ,
+.Xr ch 4  
+.Sh AUTHOR
+David Jones,
+.br
+Gordon Ross 
+.Aq gwr@netbsd.org ,
+.br
+Adam Glass
+.Aq glass@netbsd.org ,
+.br
+Jason R. Thorpe
+.Aq thorpej@netbsd.org .