d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
61e68f057a
freebsd-dev/share/man/man4/aac.4

178 lines
4.6 KiB
Groff
Raw Normal View History

The aac driver manual page Reviewed by: sheldonh@freebsd.org
2000-10-05 20:44:17 +00:00
.\" Copyright (c) 2000 Scott Long
.\" 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.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``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 OR CONTRIBUTORS 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$
- some SATA controllers were erroneously marked as SCSI, correct that - move those controllers into the right place - bump .Dd Thanks to: Justin Bennett <justin@z-axis.com> MFC after: 3 days
2005-01-04 15:59:00 +00:00
.Dd January 4, 2005
The aac driver manual page Reviewed by: sheldonh@freebsd.org
2000-10-05 20:44:17 +00:00
.Dt AAC 4
.Os
.Sh NAME
.Nm aac
.Nd Adaptec AdvancedRAID Controller driver
.Sh SYNOPSIS
.Cd options AAC_DEBUG=N
.Cd device pci
.Cd device aac
Update teh aac(4) manpage to note new controllers, the scsi passthru interface, changes to linux compatibilty, and fewer bugs.
2003-02-20 05:20:05 +00:00
.Cd device aacp
The aac driver manual page Reviewed by: sheldonh@freebsd.org
2000-10-05 20:44:17 +00:00
.Sh DESCRIPTION
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
The
The aac driver manual page Reviewed by: sheldonh@freebsd.org
2000-10-05 20:44:17 +00:00
.Nm
Update teh aac(4) manpage to note new controllers, the scsi passthru interface, changes to linux compatibilty, and fewer bugs.
2003-02-20 05:20:05 +00:00
driver provides support for the Adaptec AAC family of SCSI Ultra2, Ultra160,
Re-write some poorly written paragraphs. Document the 2130.
2004-08-13 03:55:35 +00:00
and Ultra320, and SATA RAID controllers.
The aac driver manual page Reviewed by: sheldonh@freebsd.org
2000-10-05 20:44:17 +00:00
.Pp
Access to RAID containers is available via the
.Pa /dev/aacd?
device nodes.
Re-write some poorly written paragraphs. Document the 2130.
2004-08-13 03:55:35 +00:00
The
.Nm aacp
device enables the SCSI pass-thru interface and allows devices connected
to the card such as cdroms to be available via the CAM
.Xr scsi 4
subsystem.
Note that not all cards allow this interface to be enabled.
The aac driver manual page Reviewed by: sheldonh@freebsd.org
2000-10-05 20:44:17 +00:00
.Pp
The
.Pa /dev/aac?
Add /dev/hpn? as an alias to /dev/aac? so that the HP version of the CLI utility will work, and document it in the manpage. MFC after: 3 days
2001-07-25 22:36:17 +00:00
device nodes provide access to the management interface of the controller.
mdoc(7) police: removed hard sentence breaks and trailing whitespaces.
2001-08-07 13:00:43 +00:00
One node exists per installed card.
The aliases
Add /dev/hpn? as an alias to /dev/aac? so that the HP version of the CLI utility will work, and document it in the manpage. MFC after: 3 days
2001-07-25 22:36:17 +00:00
.Pa /dev/afa?
and
.Pa /dev/hpn?
Re-write some poorly written paragraphs. Document the 2130.
2004-08-13 03:55:35 +00:00
exist for compatibilty with the Dell and HP versions of management tools,
respectively.
Update teh aac(4) manpage to note new controllers, the scsi passthru interface, changes to linux compatibilty, and fewer bugs.
2003-02-20 05:20:05 +00:00
If the kernel is compiled with the
.Dv COMPAT_LINUX
mdoc(7) police: Scheduled sweep.
2003-02-24 22:53:26 +00:00
option, or the
.Pa aac_linux.ko
and
.Pa linux.ko
modules are loaded, the
Update teh aac(4) manpage to note new controllers, the scsi passthru interface, changes to linux compatibilty, and fewer bugs.
2003-02-20 05:20:05 +00:00
Linux-compatible
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
.Xr ioctl 2
Update teh aac(4) manpage to note new controllers, the scsi passthru interface, changes to linux compatibilty, and fewer bugs.
2003-02-20 05:20:05 +00:00
interface for the management device will be enabled and will allow
Linux-based management applications to control the card.
After confering with sheldonh, it was decided that the tuning section should be renamed back to 'Tuning' and should be a subsection under 'Description'. also make a few other minor tweaks. Reviewed by: sheldonh (in principal)
2001-08-06 18:16:46 +00:00
.Ss Tuning
mdoc(7) police: removed hard sentence breaks and trailing whitespaces.
2001-08-07 13:00:43 +00:00
The read-only sysctl
Once again throw out the calculation of si_iosize_max and set it to 64K. Although it can go higher, it is not safe to so do on arrays with many members. Compromise by adding a tunable, "hw.aac.iosize_max" that can be set at boottime. Also document in the aac(4) manpage. MFC after: 4 weeks
2001-08-05 07:26:31 +00:00
.Va hw.aac.iosize_max
Clean up previous delta: * Fix typo (defautls). * Don't use hard sentence breaks in new text. * Don't introduce the use of the second person (you). * Use the standard "IMPLEMENTATION NOTES" section name instead of the non-standard "TUNING".
2001-08-05 11:15:23 +00:00
defaults to 65536 and may be set at boot time to another value via
Once again throw out the calculation of si_iosize_max and set it to 64K. Although it can go higher, it is not safe to so do on arrays with many members. Compromise by adding a tunable, "hw.aac.iosize_max" that can be set at boottime. Also document in the aac(4) manpage. MFC after: 4 weeks
2001-08-05 07:26:31 +00:00
.Xr loader 8 .
This value determines the maximum data transfer size allowed
Clean up previous delta: * Fix typo (defautls). * Don't use hard sentence breaks in new text. * Don't introduce the use of the second person (you). * Use the standard "IMPLEMENTATION NOTES" section name instead of the non-standard "TUNING".
2001-08-05 11:15:23 +00:00
to/from an array.
Setting it higher will result in better performance,
especially for large sequential access patterns.
.Em Beware :
internal limitations
of the card limit this value to 64K for arrays with many members.
While it may be safe to raise this value, this is done
.Em at the operator's own risk .
Note also that
performance peaks at a value of 96K,
and drops off dramatically at 128K,
due to other limitations of the card.
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
Controllers supported by the
.Nm
driver include:
.Pp
.Bl -bullet -compact
.It
Adaptec AAC-364
.It
- some SATA controllers were erroneously marked as SCSI, correct that - move those controllers into the right place - bump .Dd Thanks to: Justin Bennett <justin@z-axis.com> MFC after: 3 days
2005-01-04 15:59:00 +00:00
Adaptec SATA RAID 2410SA
.It
Adaptec SATA RAID 2810SA
.It
Adaptec SATA RAID 21610SA
.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
Adaptec SCSI RAID 2120S
.It
Re-write some poorly written paragraphs. Document the 2130.
2004-08-13 03:55:35 +00:00
Adaptec SCSI RAID 2130S
.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
Adaptec SCSI RAID 2200S
.It
Document the 2130SLP
2004-12-23 08:05:40 +00:00
Adaptec SCSI RAID 2130SLP
.It
List the Adaptec SCSI RAID 2230SLP.
2004-12-15 09:29:47 +00:00
Adaptec SCSI RAID 2230SLP
.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
Adaptec SCSI RAID 5400S
.It
Dell CERC SATA RAID 2
.It
Dell PERC 2/Si
.It
Dell PERC 2/QC
.It
Dell PERC 3/Si
.It
Dell PERC 3/Di
.It
Dell PERC 320/DC
.It
HP NetRAID 4M
.El
After confering with sheldonh, it was decided that the tuning section should be renamed back to 'Tuning' and should be a subsection under 'Description'. also make a few other minor tweaks. Reviewed by: sheldonh (in principal)
2001-08-06 18:16:46 +00:00
.Sh FILES
.Bl -tag -width /boot/kernel/aac.ko -compact
.It Pa /dev/aac?
aac management interface
.It Pa /dev/aacd?
disk/container interface
.It Pa /boot/kernel/aac.ko
aac loadable module
.El
The aac driver manual page Reviewed by: sheldonh@freebsd.org
2000-10-05 20:44:17 +00:00
.Sh DIAGNOSTICS
Compiling with
.Dv AAC_DEBUG
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
set to a number between 0 and 3
The aac driver manual page Reviewed by: sheldonh@freebsd.org
2000-10-05 20:44:17 +00:00
will enable increasingly verbose debug messages.
.Pp
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
The adapter can send status and alert messages asynchronously
mdoc(7) police: removed hard sentence breaks and trailing whitespaces.
2001-08-07 13:00:43 +00:00
to the driver.
These messages are printed on the system console,
The aac driver manual page Reviewed by: sheldonh@freebsd.org
2000-10-05 20:44:17 +00:00
and are also queued for retrieval by a management application.
.Sh SEE ALSO
.Xr kld 4 ,
mdoc(7) police: split punctuation characters + misc fixes.
2001-02-01 16:38:02 +00:00
.Xr linux 4 ,
Update teh aac(4) manpage to note new controllers, the scsi passthru interface, changes to linux compatibilty, and fewer bugs.
2003-02-20 05:20:05 +00:00
.Xr scsi 4 ,
blah, fix missing commas in 'SEE ALSO' section.
2001-08-06 19:21:27 +00:00
.Xr kldload 8 ,
.Xr loader 8 ,
After confering with sheldonh, it was decided that the tuning section should be renamed back to 'Tuning' and should be a subsection under 'Description'. also make a few other minor tweaks. Reviewed by: sheldonh (in principal)
2001-08-06 18:16:46 +00:00
.Xr sysctl 8
The aac driver manual page Reviewed by: sheldonh@freebsd.org
2000-10-05 20:44:17 +00:00
.Sh HISTORY
The
.Nm
driver first appeared in
Fix a manlint nit with the aac.4 manpage. Submitted by: Brooks Davis <brooks@one-eyed-alien.net>
2001-09-27 21:52:42 +00:00
.Fx 4.3 .
The aac driver manual page Reviewed by: sheldonh@freebsd.org
2000-10-05 20:44:17 +00:00
.Sh AUTHORS
.An Mike Smith
Update @freebsd.org email addresses to @FreeBSD.org as is the precedent.
2000-10-26 15:30:44 +00:00
.Aq msmith@FreeBSD.org
The aac driver manual page Reviewed by: sheldonh@freebsd.org
2000-10-05 20:44:17 +00:00
.An Scott Long
Update @freebsd.org email addresses to @FreeBSD.org as is the precedent.
2000-10-26 15:30:44 +00:00
.Aq scottl@FreeBSD.org
The aac driver manual page Reviewed by: sheldonh@freebsd.org
2000-10-05 20:44:17 +00:00
.Sh BUGS
Update teh aac(4) manpage to note new controllers, the scsi passthru interface, changes to linux compatibilty, and fewer bugs.
2003-02-20 05:20:05 +00:00
This driver is not compatible with Dell controllers that have version 1.x
firmware.
Clarify how to determine the firmware version. Submitted by: Anders Andersson <anders@codefactory.se> MFC after: 3 days
2001-09-25 22:33:53 +00:00
The firmware version is the same as the kernel version printed in the BIOS
POST and driver attach messages.
Note in the BUGS section that the driver will not work on controllers that have version 1.x firmware. This might also need to go into the release documentation, as many people seem to have been bitten by this. MFC after: 3 days
2001-09-22 04:26:35 +00:00
.Pp
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
The controller is not actually paused on suspend/resume.
The aac driver manual page Reviewed by: sheldonh@freebsd.org
2000-10-05 20:44:17 +00:00
.Pp
Reference in New Issue Copy Permalink