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