xref: /freebsd/share/man/man4/aacraid.4 (revision 8eb2bee6c0f4957c6c1cea826e59cda4d18a2a64)
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
74.Pa aacraid_linux.ko
75and
76.Pa linux.ko
77modules are loaded, the
78Linux-compatible
79.Xr ioctl 2
80interface for the management device will be enabled and will allow
81Linux-based management applications to control the card.
82.Sh HARDWARE
83Controllers supported by the
84.Nm
85driver include:
86.Pp
87.Bl -bullet -compact
88.It
89Adaptec ASR-6405(T|E)
90.It
91Adaptec ASR-6445
92.It
93Adaptec ASR-6805(T|E|Q|TQ)
94.It
95Adaptec ASR-7085
96.It
97Adaptec ASR-7805(Q)
98.It
99Adaptec ASR-70165
100.It
101Adaptec ASR-71605(E|Q)
102.It
103Adaptec ASR-71685
104.It
105Adaptec ASR-72405
106.It
107Adaptec Series 8 cards
108.El
109.Sh FILES
110.Bl -tag -width /boot/kernel/aacraid.ko -compact
111.It Pa /dev/aacraid?
112aacraid management interface
113.El
114.Sh DIAGNOSTICS
115Compiling with
116.Dv AACRAID_DEBUG
117set to a number between 0 and 3
118will enable increasingly verbose debug messages.
119.Pp
120The adapter can send status and alert messages asynchronously
121to the driver.
122These messages are printed on the system console,
123and are also queued for retrieval by a management application.
124.Sh SEE ALSO
125.Xr kld 4 ,
126.Xr linux 4 ,
127.Xr scsi 4 ,
128.Xr kldload 8
129.Sh AUTHORS
130.An Achim Leubner Aq Mt achim@FreeBSD.org
131.An \&Ed Maste Aq Mt emaste@FreeBSD.org
132.An Scott Long Aq Mt scottl@FreeBSD.org
133.Sh BUGS
134The controller is not actually paused on suspend/resume.
135