share/man/man4/aacraid.4

   1 .\" Copyright (c) 2013 Achim Leubner
   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$
  26 .Dd June 19, 2015
  27 .Dt AACRAID 4
  28 .Os
  29 .Sh NAME
  30 .Nm aacraid
  31 .Nd Adaptec AACRAID Controller driver
  32 .Sh SYNOPSIS
  33 To compile this driver into the kernel,
  34 place the following lines in your
  35 kernel configuration file:
  36 .Bd -ragged -offset indent
  37 .Cd device pci
  38 .Cd device aacraid
  39 .Pp
  40 To compile in debugging code:
  41 .Cd options AACRAID_DEBUG=N
  42 .Ed
  43 .Pp
  44 Alternatively, to load the driver as a
  45 module at boot time, place the following line in
  46 .Xr loader.conf 5 :
  47 .Bd -literal -offset indent
  48 aacraid_load="YES"
  49 .Ed
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 driver provides support for the Adaptec by PMC RAID controllers,
  54 including Series 6/7/8 and upcoming families.
  55 .Pp
  56 The RAID containers are handled via the
  57 .Nm aacraidp0
  58 bus.
  59 The physical buses are represented by the
  60 .Nm aacraidp?
  61 devices (beginning with aacraidp1).
  62 These devices enable the
  63 SCSI pass-passthrough interface and allows devices connected
  64 to the card such as CD-ROMs to be available via the CAM
  65 .Xr scsi 4
  66 subsystem.
  67 Note that not all cards allow this interface to be enabled.
  68 .Pp
  69 The
  70 .Pa /dev/aacraid?
  71 device nodes provide access to the management interface of the controller.
  72 One node exists per installed card.
  73 If the kernel is compiled with the
  74 .Dv COMPAT_LINUX
  75 option, or the
  76 .Pa aacraid_linux.ko
  77 and
  78 .Pa linux.ko
  79 modules are loaded, the
  80 Linux-compatible
  81 .Xr ioctl 2
  82 interface for the management device will be enabled and will allow
  83 Linux-based management applications to control the card.
  84 .Sh HARDWARE
  85 Controllers supported by the
  86 .Nm
  87 driver include:
  88 .Pp
  89 .Bl -bullet -compact
  90 .It
  91 Adaptec ASR-6405(T|E)
  92 .It
  93 Adaptec ASR-6445
  94 .It
  95 Adaptec ASR-6805(T|E|Q|TQ)
  96 .It
  97 Adaptec ASR-7085
  98 .It
  99 Adaptec ASR-7805(Q)
 100 .It
 101 Adaptec ASR-70165
 102 .It
 103 Adaptec ASR-71605(E|Q)
 104 .It
 105 Adaptec ASR-71685
 106 .It
 107 Adaptec ASR-72405
 108 .It
 109 Adaptec Series 8 cards
 110 .El
 111 .Sh FILES
 112 .Bl -tag -width /boot/kernel/aacraid.ko -compact
 113 .It Pa /dev/aacraid?
 114 aacraid management interface
 115 .El
 116 .Sh DIAGNOSTICS
 117 Compiling with
 118 .Dv AACRAID_DEBUG
 119 set to a number between 0 and 3
 120 will enable increasingly verbose debug messages.
 121 .Pp
 122 The adapter can send status and alert messages asynchronously
 123 to the driver.
 124 These messages are printed on the system console,
 125 and are also queued for retrieval by a management application.
 126 .Sh SEE ALSO
 127 .Xr kld 4 ,
 128 .Xr linux 4 ,
 129 .Xr scsi 4 ,
 130 .Xr kldload 8
 131 .Sh AUTHORS
 132 .An Achim Leubner Aq Mt achim@FreeBSD.org
 133 .An \&Ed Maste Aq Mt emaste@FreeBSD.org
 134 .An Scott Long Aq Mt scottl@FreeBSD.org
 135 .Sh BUGS
 136 The controller is not actually paused on suspend/resume.