xref: /freebsd/share/man/man4/aacraid.4 (revision 0782240958117692ab9861abb5483c9e64f6bc39)
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 April 09, 2013
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). These devices enable the
62SCSI pass-thru interface and allows devices connected
63to the card such as CD-ROMs to be available via the CAM
64.Xr scsi 4
65subsystem.
66Note that not all cards allow this interface to be enabled.
67.Pp
68The
69.Pa /dev/aacraid?
70device nodes provide access to the management interface of the controller.
71One node exists per installed card.
72If the kernel is compiled with the
73.Dv COMPAT_LINUX
74option, or the
75.Pa aacraid_linux.ko
76and
77.Pa linux.ko
78modules are loaded, the
79Linux-compatible
80.Xr ioctl 2
81interface for the management device will be enabled and will allow
82Linux-based management applications to control the card.
83.Sh HARDWARE
84Controllers supported by the
85.Nm
86driver include:
87.Pp
88.Bl -bullet -compact
89.It
90Adaptec ASR-6405(T|E)
91.It
92Adaptec ASR-6445
93.It
94Adaptec ASR-6805(T|E|Q|TQ)
95.It
96Adaptec ASR-7085
97.It
98Adaptec ASR-7805(Q)
99.It
100Adaptec ASR-70165
101.It
102Adaptec ASR-71605(E|Q)
103.It
104Adaptec ASR-71685
105.It
106Adaptec ASR-72405
107.It
108Adaptec Series 8 cards
109.El
110.Sh FILES
111.Bl -tag -width /boot/kernel/aacraid.ko -compact
112.It Pa /dev/aacraid?
113aacraid management interface
114.El
115.Sh DIAGNOSTICS
116Compiling with
117.Dv AACRAID_DEBUG
118set to a number between 0 and 3
119will enable increasingly verbose debug messages.
120.Pp
121The adapter can send status and alert messages asynchronously
122to the driver.
123These messages are printed on the system console,
124and are also queued for retrieval by a management application.
125.Sh SEE ALSO
126.Xr kld 4 ,
127.Xr linux 4 ,
128.Xr scsi 4 ,
129.Xr kldload 8
130.Sh AUTHORS
131.An Achim Leubner
132.Aq achim@FreeBSD.org
133.An Ed Maste
134.Aq emaste@FreeBSD.org
135.An Scott Long
136.Aq scottl@FreeBSD.org
137.Sh BUGS
138The controller is not actually paused on suspend/resume.
139