share/man/man4/aac.4

   1 .\" Copyright (c) 2000 Scott Long
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD: src/share/man/man4/aac.4,v 1.3.2.8 2001/09/27 22:01:38 scottl Exp $
  26 .\" $DragonFly: src/share/man/man4/aac.4,v 1.3 2004/12/20 14:21:19 swildner Exp $
  27 .Dd February 22, 2001
  28 .Dt AAC 4
  29 .Os
  30 .Sh NAME
  31 .Nm aac
  32 .Nd Adaptec AdvancedRAID Controller driver
  33 .Sh SYNOPSIS
  34 .Cd options AAC_COMPAT_LINUX
  35 .Cd options AAC_DEBUG=N
  36 .Cd device pci
  37 .Cd device aac
  38 .Sh DESCRIPTION
  39 The
  40 .Nm
  41 driver provides support for the Adaptec AAC family SCSI Ultra2 and Ultra160
  42 RAID controllers.
  43 These controllers support RAID 0, 1, 5, 10, and volume sets.
  44 They have four channels in the add-in version
  45 or 1-2 channels in the motherboard integrated version,
  46 and are most often found relabeled by Dell or Hewlett-Packard.
  47 Supported controllers include:
  48 .Bl -bullet
  49 .It
  50 AAC-364
  51 .It
  52 Adaptec SCSI RAID 5400S
  53 .It
  54 HP NetRAID 4M
  55 .It
  56 Dell PERC 2/Si
  57 .It
  58 Dell PERC 2/QC
  59 .It
  60 Dell PERC 3/Si
  61 .It
  62 Dell PERC 3/Di
  63 .Pp
  64 .El
  65 Access to RAID containers is available via the
  66 .Pa /dev/aacd?
  67 device nodes.
  68 Individual drives cannot be accessed
  69 unless they are part of a container or volume set,
  70 and non-fixed disks cannot be accessed.
  71 Containers can be configured by using
  72 either the on-board BIOS utility of the card,
  73 or a Linux-based management application.
  74 .Pp
  75 The
  76 .Pa /dev/aac?
  77 device nodes provide access to the management interface of the controller.
  78 One node exists per installed card.
  79 The aliases
  80 .Pa /dev/afa?
  81 and
  82 .Pa /dev/hpn?
  83 exist for the Dell and HP flavors, respectively, and are required for
  84 the CLI management utility available from these vendors to work.
  85 Compiling the driver with the
  86 .Dv AAC_COMPAT_LINUX
  87 option enables the Linux-compatible
  88 .Xr ioctl 2
  89 interface for the management device.
  90 .Ss Tuning
  91 The read-only sysctl
  92 .Va hw.aac.iosize_max
  93 defaults to 65536 and may be set at boot time to another value via
  94 .Xr loader 8 .
  95 This value determines the maximum data transfer size allowed
  96 to/from an array.
  97 Setting it higher will result in better performance,
  98 especially for large sequential access patterns.
  99 .Em Beware :
 100 internal limitations
 101 of the card limit this value to 64K for arrays with many members.
 102 While it may be safe to raise this value, this is done
 103 .Em at the operator's own risk .
 104 Note also that
 105 performance peaks at a value of 96K,
 106 and drops off dramatically at 128K,
 107 due to other limitations of the card.
 108 .Sh FILES
 109 .Bl -tag -width /modules/aac.ko -compact
 110 .It Pa /dev/aac?
 111 aac management interface
 112 .It Pa /dev/aacd?
 113 disk/container interface
 114 .It Pa /modules/aac.ko
 115 aac loadable module
 116 .El
 117 .Sh DIAGNOSTICS
 118 Compiling with
 119 .Dv AAC_DEBUG
 120 set to a number between 0 and 3
 121 will enable increasingly verbose debug messages.
 122 .Pp
 123 The adapter can send status and alert messages asynchronously
 124 to the driver.
 125 These messages are printed on the system console,
 126 and are also queued for retrieval by a management application.
 127 .Sh SEE ALSO
 128 .Xr kld 4 ,
 129 .Xr linux 4 ,
 130 .Xr kldload 8 ,
 131 .Xr loader 8 ,
 132 .Xr sysctl 8
 133 .Sh HISTORY
 134 The
 135 .Nm
 136 driver first appeared in
 137 .Fx 4.3 .
 138 .Sh AUTHORS
 139 .An Mike Smith
 140 .Aq msmith@FreeBSD.org
 141 .An Scott Long
 142 .Aq scottl@FreeBSD.org
 143 .Sh BUGS
 144 This driver is not compatible with controllers that have version 1.x firmware.
 145 The firmware version is the same as the kernel version printed in the BIOS
 146 POST and driver attach messages.
 147 .Pp
 148 This driver will not work on systems with more than 4GB of memory.
 149 .Pp
 150 The controller is not actually paused on suspend/resume.
 151 .Pp
 152 Unloading driver is not supported at this time.
 153 .Pp