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