More man page cleanups.

This commit is contained in:
Garrett Wollman 1996-01-19 22:17:57 +00:00
parent ed71c34200
commit 4b07d06bca
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=13502
9 changed files with 544 additions and 444 deletions

View File

@ -25,43 +25,43 @@
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\"
.Dd August 31, 1994
.Dd January 19, 1996
.Dt AHA 4 i386
.Os FreeBSD
.Sh NAME
.Nm aha
.Nd
Adaptec SCSI host adapter driver
.Nd Adaptec SCSI host adapter driver
.Sh SYNOPSIS
.Cd "controller aha0 at isa? port" \&"IO_AHA0\&" bio irq ? drq 5 vector ahaintr
.Cd "controller scbus0
.sp
For each connected disk:
.Cd "device sd0
.sp
For each connected tape device:
.Cd "device st0
.sp
For one or more cdroms:
.Cd "device cd0
.Cd controller "aha0 at isa? port" \&"IO_AHA0\&" "bio irq ? drq 5 vector ahaintr"
.Cd controller scbus0 at aha0
.Sh DESCRIPTION
This driver provides access to SCSI devices connected to an Adaptec
154xA, 154xB, 154xC or 164x hostadapter. It also works for compatible cards like
the BusLogic 545 and the Adaptec 174x in 154x emulation mode.
.sp
For Adaptec 174x cards in enhanced mode the ahb(4) driver should be used. This
mode is prefered over 154x emulation mode.
.Sh FILES
.Bl -tag -width Pa -compact
.It Pa /sys/i386/conf/GENERIC
sample generic kernel config file for Adaptec based systems
.It Pa /sys/i386/isa/aha.c
driver source
.El
.Sh SEE ALSO
This driver provides access to the
.Tn SCSI
bus connected to an Adaptec 154xA, 154xB, 154xC or 164x host
adapter. It also works for compatible cards like the BusLogic 545 and
the Adaptec 174x in 154x emulation mode.
For Adaptec 174x cards in enhanced mode the
.Xr ahb 4
.Xr ahc 4
.Xr cd 4
.Xr scsi 4
.Xr sd 4
driver should be used instead.
.Sh SEE ALSO
.Xr ahb 4 ,
.Xr ahc 4 ,
.Xr cd 4 ,
.Xr scsi 4 ,
.Xr sd 4 ,
.Xr st 4
.\"
.\" .Sh DIAGNOSTICS
.\"
.Sh AUTHOR
The
.Nm
driver was written by Julian Elischer for
.Tn Mach
2.5.
.Sh HISTORY
The
.Nm
driver first appeared in the
.Tn 386BSD
patchkit.

View File

@ -25,49 +25,70 @@
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\"
.Dd August 31, 1994
.Dd January 19, 1996
.Dt AHB 4 i386
.Os FreeBSD
.Sh NAME
.Nm ahb
.Nd
Adaptec EISA SCSI host adapter driver
.Nd Adaptec EISA SCSI host adapter driver
.Sh SYNOPSIS
.Cd "controller ahb0 at isa? bio irq ? vector ahbintr
.Cd "controller scbus0
.sp
For each disk:
.Cd "device sd0
.sp
For each tape device:
.Cd "device st0
.sp
For one or more cdroms:
.Cd "device cd0
.Cd controller ahb0 at isa? bio irq ? vector ahbintr
.Cd controller scbus0 at ahb0
.Sh DESCRIPTION
This driver provides access to SCSI devices connected to an Adaptec
174x hostadapter in either Standard or Enhanced Mode. If the controller
is set to Standard mode (by the ECU), the driver will automatically
switch the card to Enhanced mode during the device probe.
.sp
Please note that the above implies that when you are configuring a system
with both aha and ahb drivers, the ahb driver should be listed first in the
kernel config file. This ensures that the ahb driver will find the Adaptec 174x
boards before the aha driver probes for Adaptec 154x boards.
.sp
Note that no I/O addresses are configured in the kernel config file. The
174x uses EISA slot specific I/O which is configured automatically.
.Sh FILES
.Bl -tag -width Pa -compact
.It Pa /sys/i386/isa/ahb.c
driver source
.It Pa /sys/i386/conf/GENERIC
sample generic kernel config file for Adaptec based systems
.El
.Sh SEE ALSO
This driver provides access to the
.Tn SCSI
bus connected to an Adaptec
174x hostadapter in either
.Dq Em standard
or
.Dq Em enhanced
mode. If the controller
is set to standard mode (using the
.Tn EISA
configuration utility),
the driver will automatically
switch the card to enhanced mode during the device probe.
.Pp
.Sy N.B. :
When configuring a system
with both
.Xr aha 4
.Xr ahc 4
.Xr cd 4
.Xr scsi 4
.Xr sd 4
and
.Nm
drivers, the
.Nm
driver should be listed first in the kernel configuration file. This
ensures that the
.Nm
driver will find the Adaptec 174x boards before the
.Xr aha 4
driver probes for Adaptec 154x boards.
.Pp
Note that no I/O addresses are configured in the kernel config file. The
174x uses
.Tn EISA
slot-specific I/O which is configured automatically.
.\"
.\" .Sh DIAGNOSTICS
.\"
.Sh SEE ALSO
.Xr aha 4 ,
.Xr ahc 4 ,
.Xr cd 4 ,
.Xr scsi 4 ,
.Xr sd 4 ,
.Xr st 4
.Sh AUTHOR
The
.Nm
driver was written by Julian Elischer for
.Tn Mach
2.5. It was converted to automatic
.Tn EISA
configuration by Justin Gibbs.
.Sh HISTORY
The
.Nm
driver first appeared in the
.Tn 386BSD
patchkit.

View File

@ -30,76 +30,98 @@
.Os FreeBSD
.Sh NAME
.Nm ahc
.Nd
Adaptec VL/EISA/PCI SCSI host adapter driver
.Nd Adaptec VL/EISA/PCI SCSI host adapter driver
.Sh SYNOPSIS
For VL/EISA cards:
.Cd "controller ahc0 at isa? bio irq ? vector ahcintr
.sp
.Cd controller ahc0 at isa? bio irq ? vector ahcintr
.Pp
For PCI cards:
.Cd "controller ahc0
.sp
.Cd controller ahc0
.Pp
To enable tagged queueing:
.Cd options AHC_TAGENABLE
.Pp
For one or more SCSI busses:
.Cd "controller scbus0
.sp
For one or more disk devices:
.Cd "device sd0
.sp
For one or more tape devices:
.Cd "device st0
.sp
For one or more cdroms:
.Cd "device cd0
.Cd controller scbus0 at ahc0
.Sh DESCRIPTION
This driver provides access to SCSI devices connected to an Adaptec
274x, 284x, 294x, or motherboard based aic7770/aic7870 hostadapter.
Features include twin and wide bus support, 2 commands per target in
non-tagged queuing mode, and experimental tagged queuing support enabled
with:
.sp
.Cd "option AHC_TAGENABLE
.sp
Per target configuration performed in the SCSI-Select menu, accesible at boot
in non-EISA models or throught an EISA configuration utility for EISA models,
is honored by this driver with the stipulation that the BIOS is enabled for
EISA adaptors. This includes syncronous/asyncronous transfers, disconnection,
and maximum syncronous negotiation rate settings.
.sp
This driver provides access to the
.Tn SCSI
bus connected to an Adaptec
274x, 284x, 294x, or motherboard-based
.Tn AIC7770
or
.Tn AIC7870
host adapter.
Features include twin and wide bus support, two commands per target in
non-tagged-queuing mode, and experimental tagged queuing support enabled
with the
.Dq Dv AHC_TAGENABLE
configuration option.
.Pp
Per target configuration performed in the
.Tn SCSI-Select
menu, accesible at boot
in
.No non- Ns Tn EISA
models or through an
.Tn EISA
configuration utility for
.Tn EISA
models,
is honored by this driver with the stipulation that the
.Tn BIOS
must be enabled for
.Tn EISA
adaptors. This includes synchronous/asynchronous transfers, disconnection,
and maximum synchronous negotiation rate settings.
.Pp
Note that I/O addresses are determined automatically by the probe routines,
but care should be taken when using a 284x (VLB controller) in an EISA
but care should be taken when using a 284x
.Pq Tn VESA No local bus controller
in an
.Tn EISA
system. Ensure that the jumpers setting the I/O area for the 284x match the
EISA slot into which the card is inserted to prevent conflicts with other
EISA cards.
.Tn EISA
slot into which the card is inserted to prevent conflicts with other
.Tn EISA
cards.
.Sh BUGS
Some Quantum drives (at least the Empire 2100 and 1080s) will not run on an
aic7870 in syncronous mode at 10MB/s. It is speculated that the Adaptec
runs slightly above 10MB/s causing the drive much confusion. Setting a
maximum syncronous negotiation rate of 8MB/s in the SCSI-Select utility
.Tn AIC7870
in synchronous mode at 10MB/s. It is speculated that the Adaptec
runs slightly above 10MB/s, causing the drive much confusion. Setting a
maximum synchronous negotiation rate of 8MB/s in the
.Tn SCSI-Select
utility
will allow normal function.
.sp
The SCSI ID of aic7870 based controllers (AHA-294x) is hard coded to 7 by
the driver. The user configured ID can be obtained by querying the SEEPROM
or NVRAM where these settings are stored, but there is no driver support for
.Pp
The
.Tn SCSI
ID of
.No Tn AIC7870 Ns -based
controllers
.Pq Tn AHA-294x
is hard coded to 7 by the driver. The user configured ID can be
obtained by querying the adapter, but there is no driver support for
this as of yet.
.Sh FILES
.Bl -tag -width Pa -compact
.It Pa /sys/i386/scsi/aic7xxx.c
.It Pa /sys/i386/scsi/aic7xxx.h
Bus independent driver source
.It Pa /sys/i386/eisa/aic7770.c
EISA device probe/attach routines
.It Pa /sys/pci/aic7870.c
PCI device probe/attach routines
.It Pa /sys/dev/aic7xxx/aic7xxx.seq
aic7xxx sequencer program
.It Pa /sys/i386/conf/GENERIC
sample generic kernel config file including Adaptec support
.El
.Sh SEE ALSO
.Xr aha 4
.Xr ahb 4
.Xr aic7xxx_asm 1
.Xr cd 4
.Xr scsi 4
.Xr sd 4
.Xr aha 4 ,
.Xr ahb 4 ,
.Xr cd 4 ,
.Xr scsi 4 ,
.Xr sd 4 ,
.Xr st 4
.Sh AUTHOR
The
.Nm
driver was written by Justin Gibbs. The
.Tn AIC7xxx
sequencer-code assembler was
written by John Aycock.
.Sh HISTORY
The
.Nm
driver appeared in
.Tn FreeBSD
2.1.

View File

@ -30,32 +30,34 @@
.Os FreeBSD
.Sh NAME
.Nm bt
.Nd
Buslogic SCSI host adapter driver
.Nd Buslogic SCSI host adapter driver
.Sh SYNOPSIS
.Cd "controller bt0 at isa? port" \&"IO_BT0\&" bio irq ? vector btintr
.Cd "controller scbus0
.sp
For each connected disk:
.Cd "device sd0
.sp
For each connected tape device:
.Cd "device st0
.sp
For one or more cdroms:
.Cd "device cd0
.Cd "controller bt0 at isa? port IO_BT0 bio irq ? vector btintr"
.Cd controller scbus0 at bt0
.Sh DESCRIPTION
This driver provides access to SCSI devices connected to a Buslogic
545, 445, 742, 747 or 946 hostadapter.
.Sh FILES
.Bl -tag -width Pa -compact
.It Pa /sys/i386/conf/GENERIC
sample generic kernel config file for Buslogic based systems
.It Pa /sys/i386/isa/bt742a.c
driver source
.El
This driver provides access to the
.Tn SCSI
bus connected to a Buslogic
545, 445, 742, 747 or 946 host adapter.
.\"
.\" .Sh DIAGNOSTICS
.\"
.Sh SEE ALSO
.Xr cd 4
.Xr scsi 4
.Xr sd 4
.Xr cd 4 ,
.Xr scsi 4 ,
.Xr sd 4 ,
.Xr st 4
.Sh AUTHOR
The
.Nm
driver was written by Julian Elischer for use with
.Tn Mach
2.5. The interface for the
.Tn PCI
and
.Tn EISA
busses was written by Justin Gibbs.
.Sh HISTORY
We're not sure when the
.Nm
driver first appeared.

View File

@ -25,43 +25,43 @@
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\"
.Dd August 31, 1994
.Dd January 19, 1996
.Dt AHA 4 i386
.Os FreeBSD
.Sh NAME
.Nm aha
.Nd
Adaptec SCSI host adapter driver
.Nd Adaptec SCSI host adapter driver
.Sh SYNOPSIS
.Cd "controller aha0 at isa? port" \&"IO_AHA0\&" bio irq ? drq 5 vector ahaintr
.Cd "controller scbus0
.sp
For each connected disk:
.Cd "device sd0
.sp
For each connected tape device:
.Cd "device st0
.sp
For one or more cdroms:
.Cd "device cd0
.Cd controller "aha0 at isa? port" \&"IO_AHA0\&" "bio irq ? drq 5 vector ahaintr"
.Cd controller scbus0 at aha0
.Sh DESCRIPTION
This driver provides access to SCSI devices connected to an Adaptec
154xA, 154xB, 154xC or 164x hostadapter. It also works for compatible cards like
the BusLogic 545 and the Adaptec 174x in 154x emulation mode.
.sp
For Adaptec 174x cards in enhanced mode the ahb(4) driver should be used. This
mode is prefered over 154x emulation mode.
.Sh FILES
.Bl -tag -width Pa -compact
.It Pa /sys/i386/conf/GENERIC
sample generic kernel config file for Adaptec based systems
.It Pa /sys/i386/isa/aha.c
driver source
.El
.Sh SEE ALSO
This driver provides access to the
.Tn SCSI
bus connected to an Adaptec 154xA, 154xB, 154xC or 164x host
adapter. It also works for compatible cards like the BusLogic 545 and
the Adaptec 174x in 154x emulation mode.
For Adaptec 174x cards in enhanced mode the
.Xr ahb 4
.Xr ahc 4
.Xr cd 4
.Xr scsi 4
.Xr sd 4
driver should be used instead.
.Sh SEE ALSO
.Xr ahb 4 ,
.Xr ahc 4 ,
.Xr cd 4 ,
.Xr scsi 4 ,
.Xr sd 4 ,
.Xr st 4
.\"
.\" .Sh DIAGNOSTICS
.\"
.Sh AUTHOR
The
.Nm
driver was written by Julian Elischer for
.Tn Mach
2.5.
.Sh HISTORY
The
.Nm
driver first appeared in the
.Tn 386BSD
patchkit.

View File

@ -25,49 +25,70 @@
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\"
.Dd August 31, 1994
.Dd January 19, 1996
.Dt AHB 4 i386
.Os FreeBSD
.Sh NAME
.Nm ahb
.Nd
Adaptec EISA SCSI host adapter driver
.Nd Adaptec EISA SCSI host adapter driver
.Sh SYNOPSIS
.Cd "controller ahb0 at isa? bio irq ? vector ahbintr
.Cd "controller scbus0
.sp
For each disk:
.Cd "device sd0
.sp
For each tape device:
.Cd "device st0
.sp
For one or more cdroms:
.Cd "device cd0
.Cd controller ahb0 at isa? bio irq ? vector ahbintr
.Cd controller scbus0 at ahb0
.Sh DESCRIPTION
This driver provides access to SCSI devices connected to an Adaptec
174x hostadapter in either Standard or Enhanced Mode. If the controller
is set to Standard mode (by the ECU), the driver will automatically
switch the card to Enhanced mode during the device probe.
.sp
Please note that the above implies that when you are configuring a system
with both aha and ahb drivers, the ahb driver should be listed first in the
kernel config file. This ensures that the ahb driver will find the Adaptec 174x
boards before the aha driver probes for Adaptec 154x boards.
.sp
Note that no I/O addresses are configured in the kernel config file. The
174x uses EISA slot specific I/O which is configured automatically.
.Sh FILES
.Bl -tag -width Pa -compact
.It Pa /sys/i386/isa/ahb.c
driver source
.It Pa /sys/i386/conf/GENERIC
sample generic kernel config file for Adaptec based systems
.El
.Sh SEE ALSO
This driver provides access to the
.Tn SCSI
bus connected to an Adaptec
174x hostadapter in either
.Dq Em standard
or
.Dq Em enhanced
mode. If the controller
is set to standard mode (using the
.Tn EISA
configuration utility),
the driver will automatically
switch the card to enhanced mode during the device probe.
.Pp
.Sy N.B. :
When configuring a system
with both
.Xr aha 4
.Xr ahc 4
.Xr cd 4
.Xr scsi 4
.Xr sd 4
and
.Nm
drivers, the
.Nm
driver should be listed first in the kernel configuration file. This
ensures that the
.Nm
driver will find the Adaptec 174x boards before the
.Xr aha 4
driver probes for Adaptec 154x boards.
.Pp
Note that no I/O addresses are configured in the kernel config file. The
174x uses
.Tn EISA
slot-specific I/O which is configured automatically.
.\"
.\" .Sh DIAGNOSTICS
.\"
.Sh SEE ALSO
.Xr aha 4 ,
.Xr ahc 4 ,
.Xr cd 4 ,
.Xr scsi 4 ,
.Xr sd 4 ,
.Xr st 4
.Sh AUTHOR
The
.Nm
driver was written by Julian Elischer for
.Tn Mach
2.5. It was converted to automatic
.Tn EISA
configuration by Justin Gibbs.
.Sh HISTORY
The
.Nm
driver first appeared in the
.Tn 386BSD
patchkit.

View File

@ -30,76 +30,98 @@
.Os FreeBSD
.Sh NAME
.Nm ahc
.Nd
Adaptec VL/EISA/PCI SCSI host adapter driver
.Nd Adaptec VL/EISA/PCI SCSI host adapter driver
.Sh SYNOPSIS
For VL/EISA cards:
.Cd "controller ahc0 at isa? bio irq ? vector ahcintr
.sp
.Cd controller ahc0 at isa? bio irq ? vector ahcintr
.Pp
For PCI cards:
.Cd "controller ahc0
.sp
.Cd controller ahc0
.Pp
To enable tagged queueing:
.Cd options AHC_TAGENABLE
.Pp
For one or more SCSI busses:
.Cd "controller scbus0
.sp
For one or more disk devices:
.Cd "device sd0
.sp
For one or more tape devices:
.Cd "device st0
.sp
For one or more cdroms:
.Cd "device cd0
.Cd controller scbus0 at ahc0
.Sh DESCRIPTION
This driver provides access to SCSI devices connected to an Adaptec
274x, 284x, 294x, or motherboard based aic7770/aic7870 hostadapter.
Features include twin and wide bus support, 2 commands per target in
non-tagged queuing mode, and experimental tagged queuing support enabled
with:
.sp
.Cd "option AHC_TAGENABLE
.sp
Per target configuration performed in the SCSI-Select menu, accesible at boot
in non-EISA models or throught an EISA configuration utility for EISA models,
is honored by this driver with the stipulation that the BIOS is enabled for
EISA adaptors. This includes syncronous/asyncronous transfers, disconnection,
and maximum syncronous negotiation rate settings.
.sp
This driver provides access to the
.Tn SCSI
bus connected to an Adaptec
274x, 284x, 294x, or motherboard-based
.Tn AIC7770
or
.Tn AIC7870
host adapter.
Features include twin and wide bus support, two commands per target in
non-tagged-queuing mode, and experimental tagged queuing support enabled
with the
.Dq Dv AHC_TAGENABLE
configuration option.
.Pp
Per target configuration performed in the
.Tn SCSI-Select
menu, accesible at boot
in
.No non- Ns Tn EISA
models or through an
.Tn EISA
configuration utility for
.Tn EISA
models,
is honored by this driver with the stipulation that the
.Tn BIOS
must be enabled for
.Tn EISA
adaptors. This includes synchronous/asynchronous transfers, disconnection,
and maximum synchronous negotiation rate settings.
.Pp
Note that I/O addresses are determined automatically by the probe routines,
but care should be taken when using a 284x (VLB controller) in an EISA
but care should be taken when using a 284x
.Pq Tn VESA No local bus controller
in an
.Tn EISA
system. Ensure that the jumpers setting the I/O area for the 284x match the
EISA slot into which the card is inserted to prevent conflicts with other
EISA cards.
.Tn EISA
slot into which the card is inserted to prevent conflicts with other
.Tn EISA
cards.
.Sh BUGS
Some Quantum drives (at least the Empire 2100 and 1080s) will not run on an
aic7870 in syncronous mode at 10MB/s. It is speculated that the Adaptec
runs slightly above 10MB/s causing the drive much confusion. Setting a
maximum syncronous negotiation rate of 8MB/s in the SCSI-Select utility
.Tn AIC7870
in synchronous mode at 10MB/s. It is speculated that the Adaptec
runs slightly above 10MB/s, causing the drive much confusion. Setting a
maximum synchronous negotiation rate of 8MB/s in the
.Tn SCSI-Select
utility
will allow normal function.
.sp
The SCSI ID of aic7870 based controllers (AHA-294x) is hard coded to 7 by
the driver. The user configured ID can be obtained by querying the SEEPROM
or NVRAM where these settings are stored, but there is no driver support for
.Pp
The
.Tn SCSI
ID of
.No Tn AIC7870 Ns -based
controllers
.Pq Tn AHA-294x
is hard coded to 7 by the driver. The user configured ID can be
obtained by querying the adapter, but there is no driver support for
this as of yet.
.Sh FILES
.Bl -tag -width Pa -compact
.It Pa /sys/i386/scsi/aic7xxx.c
.It Pa /sys/i386/scsi/aic7xxx.h
Bus independent driver source
.It Pa /sys/i386/eisa/aic7770.c
EISA device probe/attach routines
.It Pa /sys/pci/aic7870.c
PCI device probe/attach routines
.It Pa /sys/dev/aic7xxx/aic7xxx.seq
aic7xxx sequencer program
.It Pa /sys/i386/conf/GENERIC
sample generic kernel config file including Adaptec support
.El
.Sh SEE ALSO
.Xr aha 4
.Xr ahb 4
.Xr aic7xxx_asm 1
.Xr cd 4
.Xr scsi 4
.Xr sd 4
.Xr aha 4 ,
.Xr ahb 4 ,
.Xr cd 4 ,
.Xr scsi 4 ,
.Xr sd 4 ,
.Xr st 4
.Sh AUTHOR
The
.Nm
driver was written by Justin Gibbs. The
.Tn AIC7xxx
sequencer-code assembler was
written by John Aycock.
.Sh HISTORY
The
.Nm
driver appeared in
.Tn FreeBSD
2.1.

View File

@ -28,152 +28,162 @@
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.TH ASC 4 "January 6, 1995" FreeBSD "FreeBSD Programmer's Manual"
.SH NAME
\fBasc\fP - a device driver for a handy scanner
.SH SYNOPSIS
.TP
\fB#include <machine/asc_ioctl.h>\fP
.TP
\fBMinor number bits:\fP \fIuu d g p ...\fP
\fIuu\fP - unit asc0 .. asc3
\fI d\fP - selects logging of \fIdebug\fP messages
\fI g\fP - selects \fIbitmap\fP vs. \fIgraymap\fP output
\fI p\fP - selects \fIraw\fP vs. portable \fIpnm\fP output
.TP
\fBdd if=/dev/asc0 of=rawfile bs=(width/8) count=(height)
.TP
\fBcat /dev/asc0p > pbmfile\fP
.PB
.SH DESCRIPTION
The \fBasc\fP character device driver currently handles the
GI1904-based hand scanner (e.g. Trust Amiscan Grey).
It uses DMA and interrupts. Input data from the scanner are
buffered, up to 50 scanlines are buffered in the driver.
.PP
The device can operate at four different \fIresolutions\fP: 100, 200,
300 and 400dpi. It produces a simple bitmap with the most significant bit
at the left side. The driver can optionally output the famous and
likely simple portable bitmap file format pbm(5) by Jef
Poskanzer. Thus the scans can easily processed by any graphic package
around (xpaint, xv, xli only to name some of them ...).
.PP
The \fIwidth\fP of the output bitmap is fixed as given by the
resolution value. However, the \fIheight\fP of the bitmap must be
supplied in \fIpnm\fP mode since the driver must know at what time the
'end-of-file' shall be reached. The default is to produce a
square image, i.e. \fIheight=width\fP. With this feature you are able to
directly copy the scanner output into a pbm file whith cat(1). Of
course you can obtain a similar effect by using dd(1) with the driver
in \fIraw\fP mode.
.PP
The \fIgraymap\fP output mode is not yet implemented into the driver.
It is even questionable if external programs would not do this job
better thereby not counting to the size of the kernel. Even though, I
do not know of tools which produce a graymap from a halftone bitmap.
.SH IOCTL REQUESTS
The ioctl requests that are served by \fBasc\fP are listed below.
There is a utility, called sasc(1), that provides access to these
requests from within shell.
.TP
ASC_GRES int
.Dd January 19, 1995
.Dt ASC 4 i386
.Os FreeBSD
.Sh NAME
.Nm asc
.Nd device driver for a GI1904-based hand scanner
.Sh SYNOPSIS
.Cd "device asc0 at isa? port IO_ASC1 tty drq 3 irq 10 vector ascintr"
.Sh DESCRIPTION
The
.Nm
character device driver currently handles the
.Tn GI1904 Ns -based
hand scanner (e.g. Trust Amiscan Grey).
It uses DMA and interrupts.
Up to 50 lines of scanned input data are buffered in the driver.
.Pp
The device can operate at four different resolutions: 100, 200, 300
and 400 dots per inch. It produces a simple bitmap with the most
significant bit at the left side. The driver can optionally output
the simple portable bitmap file format
.Xr pbm 5 ;
thus the scans can easily processed by most graphics packages.
.Pp
The width of the output bitmap is fixed as given by the
resolution value. However, the height of the bitmap must be
supplied when in
.Xr pbm 5
mode, since the driver must know at what time the
`end-of-file' shall be reached. The default is to produce a
square image; i.e., height equals width.
With this feature one is able to
directly copy the scanner output into a
.Xr pbm 5
file using
.Xr cat 1 .
One can obtain a similar effect by using
.Xr dd 1
with the driver
in raw mode.
.Sh IOCTLS
The
.Xr ioctl 2
commands applicable to
.Nm
are listed below.
The
.Xr sasc 1
provides user-level access to these commands.
.Bl -tag -width "ASC_GHEIGHT"
.It Dv ASC_GRES
.Pq Li int
Get current resolution in dots per inch (dpi).
.TP
ASC_GWIDTH int
.It Dv ASC_GWIDTH
.Pq Li int
Get current width of the bitmap in pixels.
.TP
ASC_SHEIGHT int
Set the \fIheight\fP of the bitmap in \fIpnm\fP mode. This is actually
.It Dv ASC_SHEIGHT
.Pq Li int
Set the height of the bitmap in
.Xr pbm 5
mode. This is actually
a limit on the amount of lines scannable after the first read
operation. When the limit is reached read will return 0. However, the
device is turned off only when a close is performed (either
explicitely or implicitely on exit of the calling process).
.TP
ASC_GHEIGHT int
operation. When the limit is reached, read will return 0. However, the
device is turned off only when the last open file descriptor is closed.
.It Dv ASC_GHEIGHT
.Pq Li int
Get the current height of the bitmap.
.TP
ASC_SBLEN int
.It Dv ASC_SBLEN
.Pq Li int
Set the length of the buffer used internally to do the DMA transfer.
The buffer length is supplied in lines of the bitmap. Since the buffer
size limit is (currently) 0x3000 bytes the maximum number of lines
allowed will vary with the width of each line. This upper limit is
checked before it overwrites the current value and pases an ENOMEM in
the \fBerrno\fP variable. However, since the bitmap width can change
after a buffer length was selected a read request may fail with ENOMEM
if the buffer length turns out too high. It is generally wise to
choose long buffers rather than go save in order to obtain better
output.
.TP
ASC_GBLEN int
size limit is (currently) 0x3000 bytes, the maximum number of lines
allowed will vary with the width of each line. An
.Er ENOMEM
error is returned if the requested length would exceed this limit.
.It Dv ASC_GBLEN
.Pq Li int
Get the current buffer length in lines.
.TP
ASC_SBTIME int
.It Dv ASC_SBTIME
.Pq Li int
Set the timeout for the completion of reading one buffer. Since a
handy scanner is a human/computer interface timeout values are usually
higher than those of a flat scanner. Default is 15 seconds. After
timeout is reached the read operation will fail with EBUSY. Note that
the timeout timer starts anew for each buffer to be read and thus does
not cause you to scan faster for longer images. BLEN/BTIME is similar
as MIN/TIME in termios(4).
.TP
ASC_GBTIME int
higher than those of a flat scanner; the default is 15 seconds. After
timeout is reached the read operation will fail with
.Er EBUSY .
Note that
the timeout timer starts anew for each buffer to be read and thus
reducing it does not result in faster scans for longer images.
.It Dv ASC_GBTIME
.Pq Li int
Get the current buffer timeout.
.PP
All ioctl requests that modify a parameter except ASC_SBTIME do not
have an effect on an ongoing scan process, i.e. after the first read
request that follows open. You must close the device and open it again
for the new selections to take effect. Consequently, the selections
are not reset when you close or open the device.
.PP
.El
.Pp
All
.Fn ioctl
requests that modify a parameter except
.Dv ASC_SBTIME
do not have an effect on an ongoing scan process. The user must close
the device and open it again for the new selections to take effect.
Consequently, the selections are
.Em not
reset when the device is opened or closed.
.Pp
Similarily, requests that read a value do not report the value that is
used for the ongoing scan process. The values needed during the scan
process are saved when it starts and thus are not accessed by ioctl
used for the ongoing scan process. The values needed during the scan
process are saved when it starts and thus are not accessed by
.Fn ioctl
requests.
.PP
The BTIME value does, however, have an immediate effect on the ongoing
scan. Thus the timeout can for example be set to long until the user
starts scanning. It can then be set to a short amount to react
(nearly) immediately when the user stops. Note that the user should be
left time to at least fill one buffer without having to haste.
.PP
Note that the \fIpbm\fP versus \fIraw\fP mode selection is done by the
minor number not by ioctl requests. In \fIraw\fP mode the selected
.Pp
The
.Dv ASC_SBTIME
value does, however, have an immediate effect on the ongoing scan.
Thus the timeout can, for example, be set to a large value until the
user starts scanning, and then set to a small value to react
(nearly) immediately when the user stops.
.Pp
Note that the
.Xr pbm 5
versus raw mode selection is done by the
minor number, not by
.Fn ioctl
requests. In raw mode, the selected
height of the bitmap will have no effect.
.SH FILES
.TP 15
.BI /dev/asc0
device node for \fIraw\fP output, has minor number 0.
.TP
.BI /dev/asc0d
device node for \fIraw\fP output emiting \fIdebug\fP messages if the
ASCDEBUG option was given at compile time, has minor number 32.
.TP
.BI /dev/asc0p
device node for output in \fIpbm\fP file format, has minor number 8.
.TP
.BI /dev/asc0pd
device node for \fIpbm\fP and \fIdebug\fP mode, has minor number 40.
.Sh FILES
.Bl -tag -width /dev/asc0pd -compact
.It Pa /dev/asc0
device node for raw output
.It Pa /dev/asc0d
device node for raw output, emitting debug messages if the
.Dv ASCDEBUG
option was given in the kernel configuration file
.It Pa /dev/asc0p
device node for output in
.Xr pbm 5
file format
.It Pa /dev/asc0pd
device node for
.Xr pbm 5
and debug mode
.PB
.SH DIAGNOSTICS
.TP
\fBASCDEBUG\fP
When you define this name as an `option' in the kernel configuration
you can get debug output if you access the driver with a minor number
whose debug bit (i.e. bit 5 out of 7) is set.
.SH SEE ALSO
.nh
open(2),
ioctl(2),
intro(2),
read(2),
close(2),
cat(1),
dd(1),
pbm(5),
pnm(1),
termios(4).
.hy
.SH BUGS
.\"
.\" .Sh DIAGNOSTICS
.\"
.Sh SEE ALSO
.Xr sasc 1
.Xr pbm 5
.Sh BUGS
Ioctl support is not working yet.
.SH AUTHOR
Luigi Rizzo <luigi.rizzo@iet.unipi.it>
.Sh AUTHOR
The
.Nm
driver was written by
Luigi Rizzo.
.Sh HISTORY
The
.Nm
driver first appeared in
.Tn FreeBSD
2.1.

View File

@ -30,32 +30,34 @@
.Os FreeBSD
.Sh NAME
.Nm bt
.Nd
Buslogic SCSI host adapter driver
.Nd Buslogic SCSI host adapter driver
.Sh SYNOPSIS
.Cd "controller bt0 at isa? port" \&"IO_BT0\&" bio irq ? vector btintr
.Cd "controller scbus0
.sp
For each connected disk:
.Cd "device sd0
.sp
For each connected tape device:
.Cd "device st0
.sp
For one or more cdroms:
.Cd "device cd0
.Cd "controller bt0 at isa? port IO_BT0 bio irq ? vector btintr"
.Cd controller scbus0 at bt0
.Sh DESCRIPTION
This driver provides access to SCSI devices connected to a Buslogic
545, 445, 742, 747 or 946 hostadapter.
.Sh FILES
.Bl -tag -width Pa -compact
.It Pa /sys/i386/conf/GENERIC
sample generic kernel config file for Buslogic based systems
.It Pa /sys/i386/isa/bt742a.c
driver source
.El
This driver provides access to the
.Tn SCSI
bus connected to a Buslogic
545, 445, 742, 747 or 946 host adapter.
.\"
.\" .Sh DIAGNOSTICS
.\"
.Sh SEE ALSO
.Xr cd 4
.Xr scsi 4
.Xr sd 4
.Xr cd 4 ,
.Xr scsi 4 ,
.Xr sd 4 ,
.Xr st 4
.Sh AUTHOR
The
.Nm
driver was written by Julian Elischer for use with
.Tn Mach
2.5. The interface for the
.Tn PCI
and
.Tn EISA
busses was written by Justin Gibbs.
.Sh HISTORY
We're not sure when the
.Nm
driver first appeared.