freebsd/share/man/man4/aha.4

.\"
.\" Copyright (c) 1994 Wilko Bulte
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. The name of the author may not be used to endorse or promote products
.\"    derived from this software without specific prior written permission
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" 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.
.\"
.\" $FreeBSD$
.\"
.Dd July 4, 2004
.Dt AHA 4
.Os
.Sh NAME
.Nm aha
.Nd Adaptec SCSI host adapter driver
.Sh SYNOPSIS
To compile this driver into the kernel,
place the following lines in your
kernel configuration file:
.Bd -ragged -offset indent
.Cd "device scbus"
.Cd "device aha"
.Ed
.Pp
Alternatively, to load the driver as a
module at boot time, place the following line in
.Xr loader.conf 5 :
.Bd -literal -offset indent
aha_load="YES"
.Ed
.Pp
In
.Pa /boot/device.hints :
.Cd hint.aha.0.at="isa"
.Sh DESCRIPTION
This driver provides access to the
.Tn SCSI
bus connected to the Adaptec AHA-154x and AHA-1640 SCSI host adapters.
x is 0 for controllers without a floppy drive and 2 for controllers
that have them.
For optimum
performance, Adaptec AHA-174x controllers should be configured in
enhanced mode and attached via the
.Xr ahb 4
driver.
.Pp
One device hint entry for every card to be attached by the system is
required.
Specific values for the port address, IRQ, and DRQ may be specified.
If wildcard values are used, the driver will query the device for its
current settings and use those.
If the port address
is a wildcard, the driver consults an internal table of possible port address
locations and attaches to the first unattached card it finds.
The possible
port addresses for this card are 0x330, 0x334, 0x230, 0x234, 0x130, and
0x134.
.Pp
The AHA-1640 is an MCA bus card.
Since the MCA bus is a self-identifying bus, no setting of hints is
required.
.Sh HARDWARE
The
.Nm
driver supports the following SCSI host adapters:
.Pp
.Bl -bullet -compact
.It
Adaptec AHA-154xB
.It
Adaptec AHA-154xC
.It
Adaptec AHA-154xCF
.It
Adaptec AHA-154xCP
.It
Adaptec AHA-1640
.It
Adaptec AHA-174x in 154x emulation mode
.It
DTC 3290 SCSI controller in 1542 emulation mode
.It
Tekram SCSI controllers in 154x emulation mode
.El
.Sh SEE ALSO
.Xr ahb 4 ,
.Xr ahc 4 ,
.Xr aic 4 ,
.Xr cd 4 ,
.Xr da 4 ,
.Xr sa 4 ,
.Xr scsi 4
.\"
.\" .Sh DIAGNOSTICS
.\"
.Sh AUTHORS
.An -nosplit
The
.Nm
driver was ported by
.An M. Warner Losh
from the
.Nm bt
driver written by
.An Justin T. Gibbs .
.Sh BUGS
The AHA-154xA card does not support residuals on data transfers.
As a result, this card is no longer supported.
.Pp
There have been some reports that the AHA-154xB does not work well
under heavy load.
.Pp
The AHA-154xCP is a plug and play controller.
However, its resources are set using the on-board BIOS and cannot be
moved.
Failures to attached for this card are often caused when the resources
set in the BIOS conflict.
Add new files from Wilko (and in their proper place). Submitted by: Wilko Bulte 1994-09-29 13:54:36 +00:00			`.\"`
			`.\" Copyright (c) 1994 Wilko Bulte`
			`.\" All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 3. The name of the author may not be used to endorse or promote products`
Spelling police: withough -> without Submitted by: Joseph Mallett <jmallett@xMach.org> 2001-08-23 21:36:18 +00:00			`.\" derived from this software without specific prior written permission`
Add new files from Wilko (and in their proper place). Submitted by: Wilko Bulte 1994-09-29 13:54:36 +00:00			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
			`.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES`
			`.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.`
			`.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,`
			`.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT`
			`.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,`
			`.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY`
			`.\" 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.`
			`.\"`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
Add new files from Wilko (and in their proper place). Submitted by: Wilko Bulte 1994-09-29 13:54:36 +00:00			`.\"`
Add a HARDWARE section which lists supported devices. The actual device listings has been moved (and in some cases more or less rewritten) from the DESCRIPTION section. This will be used later for automatically generating device listings in the Hardware Notes, by parsing the manual pages. Reviewed in principle by: ru, hrs, trhodes No objections: -doc, re Section name inspired by: NetBSD 2004-07-04 14:17:41 +00:00			`.Dd July 4, 2004`
Remove the MD part from the document title. Forgotten by: obrien 2001-02-20 11:07:27 +00:00			`.Dt AHA 4`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 15:31:11 +00:00			`.Os`
Add new files from Wilko (and in their proper place). Submitted by: Wilko Bulte 1994-09-29 13:54:36 +00:00			`.Sh NAME`
			`.Nm aha`
More man page cleanups. 1996-01-19 22:17:57 +00:00			`.Nd Adaptec SCSI host adapter driver`
Add new files from Wilko (and in their proper place). Submitted by: Wilko Bulte 1994-09-29 13:54:36 +00:00			`.Sh SYNOPSIS`
Convert to use a SYNPOSIS section that mentions kernel modules. Also add "device scbus" where needed. MFC after: 3 days 2006-05-20 09:39:28 +00:00			`To compile this driver into the kernel,`
			`place the following lines in your`
			`kernel configuration file:`
			`.Bd -ragged -offset indent`
			`.Cd "device scbus"`
			`.Cd "device aha"`
			`.Ed`
			`.Pp`
			`Alternatively, to load the driver as a`
			`module at boot time, place the following line in`
			`.Xr loader.conf 5 :`
			`.Bd -literal -offset indent`
			`aha_load="YES"`
			`.Ed`
Update man pages in the section 4 to match the reality in -CURRENT. - Change lines referring to kernel configuration file: device foo0 at isa port xxx irq yyy... to device foo Describe resource "hints" in /boot/device.hints. - Try to describe resource allocation and probe/attach behavior in the newbus framework. 2001-10-13 09:08:37 +00:00			`.Pp`
			`In`
			`.Pa /boot/device.hints :`
			`.Cd hint.aha.0.at="isa"`
Add new files from Wilko (and in their proper place). Submitted by: Wilko Bulte 1994-09-29 13:54:36 +00:00			`.Sh DESCRIPTION`
More man page cleanups. 1996-01-19 22:17:57 +00:00			`This driver provides access to the`
			`.Tn SCSI`
Add a HARDWARE section which lists supported devices. The actual device listings has been moved (and in some cases more or less rewritten) from the DESCRIPTION section. This will be used later for automatically generating device listings in the Hardware Notes, by parsing the manual pages. Reviewed in principle by: ru, hrs, trhodes No objections: -doc, re Section name inspired by: NetBSD 2004-07-04 14:17:41 +00:00			`bus connected to the Adaptec AHA-154x and AHA-1640 SCSI host adapters.`
o Update to closer to the official names for these cards. o Remove entries for 1510, 152x and 1535. These are supported, for some value of supported, by the aic driver. o Add notes about 1542-CP being plug and play, but it can still conflict with other resources because all the resources it uses are set with the onboard BIOS. 2003-11-09 01:30:46 +00:00			`x is 0 for controllers without a floppy drive and 2 for controllers`
			`that have them.`
Hiten's patchset for section four manpages, slightly edited by me. 2003-06-28 23:53:39 +00:00			`For optimum`
o Update to closer to the official names for these cards. o Remove entries for 1510, 152x and 1535. These are supported, for some value of supported, by the aic driver. o Add notes about 1542-CP being plug and play, but it can still conflict with other resources because all the resources it uses are set with the onboard BIOS. 2003-11-09 01:30:46 +00:00			`performance, Adaptec AHA-174x controllers should be configured in`
Update the aha(4) and ahb(4) man pages for CAM. Reviewed by: ken Submitted by: gibbs 1998-10-16 04:41:38 +00:00			`enhanced mode and attached via the`
Add new files from Wilko (and in their proper place). Submitted by: Wilko Bulte 1994-09-29 13:54:36 +00:00			`.Xr ahb 4`
Update the aha(4) and ahb(4) man pages for CAM. Reviewed by: ken Submitted by: gibbs 1998-10-16 04:41:38 +00:00			`driver.`
			`.Pp`
o Update to closer to the official names for these cards. o Remove entries for 1510, 152x and 1535. These are supported, for some value of supported, by the aic driver. o Add notes about 1542-CP being plug and play, but it can still conflict with other resources because all the resources it uses are set with the onboard BIOS. 2003-11-09 01:30:46 +00:00			`One device hint entry for every card to be attached by the system is`
Hiten's patchset for section four manpages, slightly edited by me. 2003-06-28 23:53:39 +00:00			`required.`
Assorted markup, spelling, and grammar fixes. 2004-06-16 08:33:57 +00:00			`Specific values for the port address, IRQ, and DRQ may be specified.`
o Update to closer to the official names for these cards. o Remove entries for 1510, 152x and 1535. These are supported, for some value of supported, by the aic driver. o Add notes about 1542-CP being plug and play, but it can still conflict with other resources because all the resources it uses are set with the onboard BIOS. 2003-11-09 01:30:46 +00:00			`If wildcard values are used, the driver will query the device for its`
			`current settings and use those.`
Hiten's patchset for section four manpages, slightly edited by me. 2003-06-28 23:53:39 +00:00			`If the port address`
Update the aha(4) and ahb(4) man pages for CAM. Reviewed by: ken Submitted by: gibbs 1998-10-16 04:41:38 +00:00			`is a wildcard, the driver consults an internal table of possible port address`
Hiten's patchset for section four manpages, slightly edited by me. 2003-06-28 23:53:39 +00:00			`locations and attaches to the first unattached card it finds.`
			`The possible`
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f\|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days 2001-07-14 19:41:16 +00:00			`port addresses for this card are 0x330, 0x334, 0x230, 0x234, 0x130, and`
Update the aha(4) and ahb(4) man pages for CAM. Reviewed by: ken Submitted by: gibbs 1998-10-16 04:41:38 +00:00			`0x134.`
o Update to closer to the official names for these cards. o Remove entries for 1510, 152x and 1535. These are supported, for some value of supported, by the aic driver. o Add notes about 1542-CP being plug and play, but it can still conflict with other resources because all the resources it uses are set with the onboard BIOS. 2003-11-09 01:30:46 +00:00			`.Pp`
Assorted markup, spelling, and grammar fixes. 2004-06-16 08:33:57 +00:00			`The AHA-1640 is an MCA bus card.`
Add the meteor driver man page back. It has moved up a level from the man4.i386. It documents that meteor no longer works, but keeps the extensive documentation on the meteor interface, which the bktr driver implements also. This should be merged into tha man page, but such a merging seems to be planned by others. # we really need something like video4bsd to define these sorts of # things for all video capture drivers. Requested by: rwatson and obrien 2003-12-08 02:59:34 +00:00			`Since the MCA bus is a self-identifying bus, no setting of hints is`
			`required.`
Add a HARDWARE section which lists supported devices. The actual device listings has been moved (and in some cases more or less rewritten) from the DESCRIPTION section. This will be used later for automatically generating device listings in the Hardware Notes, by parsing the manual pages. Reviewed in principle by: ru, hrs, trhodes No objections: -doc, re Section name inspired by: NetBSD 2004-07-04 14:17:41 +00:00			`.Sh HARDWARE`
			`The`
			`.Nm`
			`driver supports the following SCSI host adapters:`
			`.Pp`
			`.Bl -bullet -compact`
			`.It`
			`Adaptec AHA-154xB`
			`.It`
			`Adaptec AHA-154xC`
			`.It`
			`Adaptec AHA-154xCF`
			`.It`
			`Adaptec AHA-154xCP`
			`.It`
			`Adaptec AHA-1640`
			`.It`
			`Adaptec AHA-174x in 154x emulation mode`
			`.It`
Move listing of DTC 3290 to aha(4). MFC after: 3 days 2004-08-19 20:49:39 +00:00			`DTC 3290 SCSI controller in 1542 emulation mode`
			`.It`
Add a HARDWARE section which lists supported devices. The actual device listings has been moved (and in some cases more or less rewritten) from the DESCRIPTION section. This will be used later for automatically generating device listings in the Hardware Notes, by parsing the manual pages. Reviewed in principle by: ru, hrs, trhodes No objections: -doc, re Section name inspired by: NetBSD 2004-07-04 14:17:41 +00:00			`Tekram SCSI controllers in 154x emulation mode`
			`.El`
More man page cleanups. 1996-01-19 22:17:57 +00:00			`.Sh SEE ALSO`
			`.Xr ahb 4 ,`
			`.Xr ahc 4 ,`
o Update to closer to the official names for these cards. o Remove entries for 1510, 152x and 1535. These are supported, for some value of supported, by the aic driver. o Add notes about 1542-CP being plug and play, but it can still conflict with other resources because all the resources it uses are set with the onboard BIOS. 2003-11-09 01:30:46 +00:00			`.Xr aic 4 ,`
More man page cleanups. 1996-01-19 22:17:57 +00:00			`.Xr cd 4 ,`
Update the aha(4) and ahb(4) man pages for CAM. Reviewed by: ken Submitted by: gibbs 1998-10-16 04:41:38 +00:00			`.Xr da 4 ,`
Various man page cleanup: - Sort xrefs - FreeBSD.ORG -> FreeBSD.org - Be consistent with section names as outlined in mdoc(7). - Other misc mdoc cleanup. PR: doc/13144 Submitted by: Alexey M. Zelkin <phantom@cris.net> 1999-08-15 10:48:36 +00:00			`.Xr sa 4 ,`
			`.Xr scsi 4`
More man page cleanups. 1996-01-19 22:17:57 +00:00			`.\"`
			`.\" .Sh DIAGNOSTICS`
			`.\"`
Various man page cleanup: - Sort xrefs - FreeBSD.ORG -> FreeBSD.org - Be consistent with section names as outlined in mdoc(7). - Other misc mdoc cleanup. PR: doc/13144 Submitted by: Alexey M. Zelkin <phantom@cris.net> 1999-08-15 10:48:36 +00:00			`.Sh AUTHORS`
mdoc(7) police: do not split author names in the AUTHORS section. 2000-11-22 09:35:58 +00:00			`.An -nosplit`
More man page cleanups. 1996-01-19 22:17:57 +00:00			`The`
			`.Nm`
Various man page cleanup: - Sort xrefs - FreeBSD.ORG -> FreeBSD.org - Be consistent with section names as outlined in mdoc(7). - Other misc mdoc cleanup. PR: doc/13144 Submitted by: Alexey M. Zelkin <phantom@cris.net> 1999-08-15 10:48:36 +00:00			`driver was ported by`
			`.An M. Warner Losh`
			`from the`
Update the aha(4) and ahb(4) man pages for CAM. Reviewed by: ken Submitted by: gibbs 1998-10-16 04:41:38 +00:00			`.Nm bt`
Various man page cleanup: - Sort xrefs - FreeBSD.ORG -> FreeBSD.org - Be consistent with section names as outlined in mdoc(7). - Other misc mdoc cleanup. PR: doc/13144 Submitted by: Alexey M. Zelkin <phantom@cris.net> 1999-08-15 10:48:36 +00:00			`driver written by`
mdoc(7) police: do not split author names in the AUTHORS section. 2000-11-22 09:35:58 +00:00			`.An Justin T. Gibbs .`
Sort sections. 2005-01-21 08:36:40 +00:00			`.Sh BUGS`
			`The AHA-154xA card does not support residuals on data transfers.`
			`As a result, this card is no longer supported.`
			`.Pp`
			`There have been some reports that the AHA-154xB does not work well`
			`under heavy load.`
			`.Pp`
			`The AHA-154xCP is a plug and play controller.`
			`However, its resources are set using the on-board BIOS and cannot be`
			`moved.`
			`Failures to attached for this card are often caused when the resources`
			`set in the BIOS conflict.`