xref: /freebsd/share/man/man4/ips.4 (revision d8a0fe102c0cfdfcd5b818f850eff09d8536c9bc)
1.\"
2.\" Copyright (c) 2003 Tom Rhodes
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.\" $FreeBSD$
27.\"
28.Dd August 7, 2009
29.Dt IPS 4
30.Os
31.Sh NAME
32.Nm ips
33.Nd IBM/Adaptec ServeRAID controller driver
34.Sh SYNOPSIS
35To compile this driver into the kernel,
36place the following lines in your
37kernel configuration file:
38.Bd -ragged -offset indent
39.Cd "device pci"
40.Cd "device scbus"
41.Cd "device ips"
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
48ips_load="YES"
49.Ed
50.Sh DESCRIPTION
51The
52.Nm
53driver claims to support the
54.Tn IBM
55(now Adaptec) ServeRAID series
56.Tn SCSI
57controller cards.
58.Pp
59These cards come with a built in configuration utility stored in
60the firmware known as the
61.Tn ISPR .
62This utility is accessed with the
63.Aq Em Ctrl+I
64key combination during the initial card
65.Tn POST .
66.Pp
67It is highly recommended that this utility be used to configure the card
68before attempting to diagnose the below error messages.
69.Pp
70In some cases, the
71.Nm
72driver can have difficulties attaching during
73the system initialization period.
74To avoid these difficulties, set the
75.Va hw.ips.0.disable
76tunable to 1.
77It will prevent the driver from attaching.
78.Sh HARDWARE
79Controllers supported by the
80.Nm
81driver include:
82.Pp
83.Bl -bullet -compact
84.It
85IBM ServeRAID 3H
86.It
87ServeRAID 4L/4M/4H
88.It
89ServeRAID Series 5
90.It
91ServeRAID 6i/6M
92.It
93ServeRAID 7t/7k/7M
94.El
95.Pp
96Newer ServeRAID controllers are supported by the
97.Xr aac 4
98or
99.Xr mfi 4
100driver.
101.Sh DIAGNOSTICS
102Several error codes may be shown when the card initializes the
103.Tn IBM
104.Tn ISPR
105utility and are independent of
106.Fx .
107.Bl -diag
108.It ips%d: failed to get adapter configuration data from device
109.It ips%d: failed to get drive configuration data from device
110.Pp
111Unable to obtain adapter or drive configuration.
112.It ips%d iobuf error
113.Pp
114A buffer input/output error has occurred.
115.Bq Er ENXIO
116.El
117.Ss General adapter errors:
118.Bl -diag
119.It Attaching bus failed
120.Pp
121This message is undocumented.
122.It WARNING: command timeout. Adapter is in toaster mode, resetting
123.Pp
124A command timeout has caused the adapter to be reset.
125.It AIEE! adapter reset failed, giving up and going home! Have a nice day
126.Pp
127An error occurred while attempting to reset the adapter.
128.It unable to get adapter configuration
129.It unable to get drive configuration
130.Pp
131There was an error when attempting to get configuration information.
132.It Adapter error during initialization.
133.It adapter initialization failed
134.Pp
135There was an error while attempting to initialize the adapter.
136.It adapter failed config check
137.It adapter clear failed
138.Pp
139There was an error while checking the adapter.
140.It device is disabled
141.Pp
142The adapter is disabled.
143.It resource allocation failed
144.It irq allocation failed
145.It irq setup failed
146.Pp
147The driver was unable to allocate resources for the device.
148.El
149.Ss Error messages due to DMA:
150.Bl -diag
151.It can't alloc command dma tag
152.It can't alloc SG dma tag
153.It can't alloc dma tag for statue queue
154.It dmamap failed
155.Pp
156Failure to map or allocate DMA resources.
157.El
158.Ss Cache, buffer, and command errors:
159.Bl -diag
160.It failed to initialize command buffers
161.It no mem for command slots!
162.Pp
163The
164.Nm
165driver will return
166.Bq Er ENOMEM
167in such cases.
168.It ERROR: unable to get a command! can't flush cache!
169.It ERROR: cache flush command failed!
170.It ERROR: unable to get a command! can't update nvram
171.It ERROR: nvram update command failed!
172.It ERROR: unable to get a command! can't sync cache!
173.It ERROR: cache sync command failed!
174.It ERROR: unable to get a command! can't sync cache!
175.It ERROR: etable command failed!
176.El
177.Sh COMPATIBILITY
178Unlike many of the other
179.Tn SCSI
180devices in
181.Fx ,
182the
183.Nm
184driver does not use the
185.Xr cam 4
186.Tn SCSI
187subsystem.
188.Sh SEE ALSO
189.Xr aac 4 ,
190.Xr ch 4 ,
191.Xr da 4 ,
192.Xr mfi 4 ,
193.Xr sysctl 8
194.Sh AUTHORS
195The
196.Nm
197driver was written by
198.An -nosplit
199.An David Jefferys
200and
201.An Scott Long Aq Mt scottl@FreeBSD.org .
202.Pp
203This manual page was written by
204.An Tom Rhodes Aq Mt trhodes@FreeBSD.org .
205