| blob | 26fc261a02d568f3c9795aced2b482f83328c4f9 |
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 November 4, 2006
29 .Dt IPS 4
30 .Os
31 .Sh NAME
32 .Nm ips
33 .Nd IBM/Adaptec ServeRAID controller driver
34 .Sh SYNOPSIS
35 To compile this driver into the kernel,
36 place the following lines in your
37 kernel configuration file:
38 .Bd -ragged -offset indent
39 .Cd "device pci"
40 .Cd "device scbus"
41 .Cd "device ips"
42 .Ed
43 .Pp
44 Alternatively, to load the driver as a
45 module at boot time, place the following line in
46 .Xr loader.conf 5 :
47 .Bd -literal -offset indent
48 ips_load="YES"
49 .Ed
50 .Sh DESCRIPTION
51 The
52 .Nm
53 driver claims to support the
54 .Tn IBM
55 (now Adaptec) ServeRAID series
56 .Tn SCSI
57 controller cards.
58 .Pp
59 These cards come with a built in configuration utility stored in
60 the firmware known as the
61 .Tn ISPR .
62 This utility is accessed with the
63 .Aq Em Ctrl+I
64 key combination during the initial card
65 .Tn POST .
66 .Pp
67 It is highly recommended that this utility be used to configure the card
68 before attempting to diagnose the below error messages.
69 .Pp
70 In some cases, the
71 .Nm
72 driver can have difficulties attaching during
73 the system initialization period.
74 To avoid these difficulties, set the
75 .Va hw.ips.0.disable
76 tunable to 1.
77 It will prevent the driver from attaching.
78 .Sh HARDWARE
79 Controllers supported by the
80 .Nm
81 driver include:
82 .Pp
83 .Bl -bullet -compact
84 .It
85 IBM ServeRAID 3H
86 .It
87 ServeRAID 4L/4M/4H
88 .It
89 ServeRAID Series 5
90 .It
91 ServeRAID 6i/6M
92 .It
93 ServeRAID 7t/7k/7M
94 .El
95 .Sh DIAGNOSTICS
96 Several error codes may be shown when the card initializes the
97 .Tn IBM
98 .Tn ISPR
99 utility and are independent of
100 .Fx .
101 .Bl -diag
102 .It ips%d: failed to get adapter configuration data from device
103 .It ips%d: failed to get drive configuration data from device
104 .Pp
105 Unable to obtain adapter or drive configuration.
106 .It ips%d iobuf error
107 .Pp
108 A buffer input/output error has occurred.
109 .Bq Er ENXIO
110 .El
111 .Ss General adapter errors:
112 .Bl -diag
113 .It Attaching bus failed
114 .Pp
115 This message is undocumented.
116 .It WARNING: command timeout. Adapter is in toaster mode, resetting
117 .Pp
118 A command timeout has caused the adapter to be reset.
119 .It AIEE! adapter reset failed, giving up and going home! Have a nice day
120 .Pp
121 An error occurred while attempting to reset the adapter.
122 .It unable to get adapter configuration
123 .It unable to get drive configuration
124 .Pp
125 There was an error when attempting to get configuration information.
126 .It Adapter error during initialization.
127 .It adapter initialization failed
128 .Pp
129 There was an error while attempting to initialize the adapter.
130 .It adapter failed config check
131 .It adapter clear failed
132 .Pp
133 There was an error while checking the adapter.
134 .It device is disabled
135 .Pp
136 The adapter is disabled.
137 .It resource allocation failed
138 .It irq allocation failed
139 .It irq setup failed
140 .Pp
141 The driver was unable to allocate resources for the device.
142 .El
143 .Ss Error messages due to DMA:
144 .Bl -diag
145 .It can't alloc command dma tag
146 .It can't alloc SG dma tag
147 .It can't alloc dma tag for statue queue
148 .It dmamap failed
149 .Pp
150 Failure to map or allocate DMA resources.
151 .El
152 .Ss Cache, buffer, and command errors:
153 .Bl -diag
154 .It failed to initialize command buffers
155 .It no mem for command slots!
156 .Pp
157 The
158 .Nm
159 driver will return
160 .Bq Er ENOMEM
161 in such cases.
162 .It ERROR: unable to get a command! can't flush cache!
163 .It ERROR: cache flush command failed!
164 .It ERROR: unable to get a command! can't update nvram
165 .It ERROR: nvram update command failed!
166 .It ERROR: unable to get a command! can't sync cache!
167 .It ERROR: cache sync command failed!
168 .It ERROR: unable to get a command! can't sync cache!
169 .It ERROR: etable command failed!
170 .El
171 .Sh COMPATIBILITY
172 Unlike many of the other
173 .Tn SCSI
174 devices in
175 .Fx ,
176 the
177 .Nm
178 driver does not use the
179 .Xr cam 4
180 .Tn SCSI
181 subsystem.
182 .Sh SEE ALSO
183 .Xr ch 4 ,
184 .Xr da 4 ,
185 .Xr sysctl 8
186 .Sh AUTHORS
187 The
188 .Nm
189 driver was written by
190 .An -nosplit
191 .An David Jefferys
192 and
193 .An Scott Long Aq scottl@FreeBSD.org .
194 .Pp
195 This manual page was written by
196 .An Tom Rhodes Aq trhodes@FreeBSD.org .