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

153 lines
4.5 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$
MFS: update HISTORY, synch dates.
2001-03-07 12:52:53 +00:00
.Dd February 22, 2001
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_COMPAT_LINUX
.Cd options AAC_DEBUG=N
.Cd device pci
.Cd device aac
.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
driver provides support for the Adaptec AAC family SCSI Ultra2 and Ultra160
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
RAID controllers.
The aac driver manual page Reviewed by: sheldonh@freebsd.org
2000-10-05 20:44:17 +00:00
These controllers support RAID 0, 1, 5, 10, and volume sets.
They have four channels in the add-in version
or 1-2 channels in the motherboard integrated version,
Spelling police: relabelled -> relabeled PR: 29985 Submitted by: {aac,amr,mlx}.4
2001-08-23 21:52:38 +00:00
and are most often found relabeled by Dell or Hewlett-Packard.
The aac driver manual page Reviewed by: sheldonh@freebsd.org
2000-10-05 20:44:17 +00:00
Supported controllers include:
.Bl -bullet
.It
AAC-364
.It
Mega update to the aac driver. 1. Correctly handle commands initiated by the adapter. These commands are defered to a kthread responsible for their processing, then are properly returned to the controller. 2. Add/remove disk devices when notified by the card that a container was created/deleted/offline. 3. Implement crashdump functionality. 4. Support all ioctls needed for the management CLI to work. The linux version of this app can be found at the Dell or HP website. A native version will be forthcoming. MFC-after: 4.4-RELEASE
2001-08-29 23:34:05 +00:00
Adaptec SCSI RAID 5400S
The aac driver manual page Reviewed by: sheldonh@freebsd.org
2000-10-05 20:44:17 +00:00
.It
HP NetRAID 4M
.It
Dell PERC 2/Si
.It
Dell PERC 2/QC
.It
Dell PERC 3/Si
.It
Dell PERC 3/Di
.Pp
.El
Access to RAID containers is available via the
.Pa /dev/aacd?
device nodes.
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
Individual drives cannot be accessed
The aac driver manual page Reviewed by: sheldonh@freebsd.org
2000-10-05 20:44:17 +00:00
unless they are part of a container or volume set,
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
and non-fixed disks cannot be accessed.
The aac driver manual page Reviewed by: sheldonh@freebsd.org
2000-10-05 20:44:17 +00:00
Containers can be configured by using
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
either the on-board BIOS utility of the card,
The aac driver manual page Reviewed by: sheldonh@freebsd.org
2000-10-05 20:44:17 +00:00
or a Linux-based management application.
.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?
exist for the Dell and HP flavors, respectively, and are required for
the CLI management utility available from these vendors to work.
The aac driver manual page Reviewed by: sheldonh@freebsd.org
2000-10-05 20:44:17 +00:00
Compiling the driver with the
.Dv AAC_COMPAT_LINUX
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
option enables the Linux-compatible
.Xr ioctl 2
interface for the management device.
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.
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 ,
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
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
This driver is not compatible with 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
Mega update to the aac driver. 1. Correctly handle commands initiated by the adapter. These commands are defered to a kthread responsible for their processing, then are properly returned to the controller. 2. Add/remove disk devices when notified by the card that a container was created/deleted/offline. 3. Implement crashdump functionality. 4. Support all ioctls needed for the management CLI to work. The linux version of this app can be found at the Dell or HP website. A native version will be forthcoming. MFC-after: 4.4-RELEASE
2001-08-29 23:34:05 +00:00
This driver will not work on systems with more than 4GB of memory.
The aac driver manual page Reviewed by: sheldonh@freebsd.org
2000-10-05 20:44:17 +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
Mega update to the aac driver. 1. Correctly handle commands initiated by the adapter. These commands are defered to a kthread responsible for their processing, then are properly returned to the controller. 2. Add/remove disk devices when notified by the card that a container was created/deleted/offline. 3. Implement crashdump functionality. 4. Support all ioctls needed for the management CLI to work. The linux version of this app can be found at the Dell or HP website. A native version will be forthcoming. MFC-after: 4.4-RELEASE
2001-08-29 23:34:05 +00:00
Unloading driver is not supported at this time.
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