forgotten file
[dragonfly.git] / share / man / man4 / ips.4
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: src/share/man/man4/ips.4,v 1.2 2003/11/12 02:26:47 hmp Exp $
27 .\" $DragonFly: src/share/man/man4/ips.4,v 1.2 2004/03/11 12:28:55 hmp Exp $
28 .\"
29 .Dd November 11, 2003
30 .Dt IPS 4
31 .Os
32 .Sh NAME
33 .Nm ips
34 .Nd IBM/Adaptec ServeRAID controller driver
35 .Sh SYNOPSIS
36 .Cd device scbus
37 .Cd device ips
38 .Sh DESCRIPTION
39 The
40 .Nm
41 driver claims to support the
42 .Tn IBM
43 (now Adaptec) ServeRAID series
44 .Tn SCSI
45 controller cards.
46 Some supported devices include:
47 .Pp
48 .Bl -item -compact
49 .It
50 IBM ServeRAID 3H
51 .It
52 ServeRAID 4L/4M/4H
53 .It
54 ServeRAID Series 5
55 .It
56 ServeRAID 6i/6M
57 .El
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 .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 .Dl hw.ips.0.disable
76 tunable to
77 .Dq 1 .
78 This
79 .Tn MIB
80 prevents the driver from attaching.
81 .Sh DIAGNOSTICS
82 Several error codes may be shown when the card initializes the
83 .Tn IBM
84 .Tn ISPR
85 utility and are independent of
86 .Dx .
87 .Pp
88 .Bl -diag
89 .It ips%d: failed to get adapter configuration data from device
90 .It ips%d: failed to get drive configuration data from device
91 .Pp
92 Unable to obtain adapter or drive configuration.
93 .It ips%d iobuf error
94 .Pp
95 A buffer input/output error has occurred.
96 .Bq Er ENXIO
97 .El
98 .Ss General adapter errors:
99 .Bl -diag
100 .It Attaching bus failed
101 .Pp
102 This message is undocumented.
103 .It WARNING: command timeout. Adapter is in toaster mode, resetting
104 .Pp
105 A command timeout has caused the adapter to be reset.
106 .It AIEE! adapter reset failed, giving up and going home! Have a nice day
107 .Pp
108 An error occurred while attempting to reset the adapter.
109 .It unable to get adapter configuration
110 .It unable to get drive configuration
111 .Pp
112 There was an error when attempting to get configuration information.
113 .It Adapter error during initialization.
114 .It adapter initialization failed
115 .Pp
116 There was an error while attempting to initialize the adapter.
117 .It adapter failed config check
118 .It adapter clear failed
119 .Pp
120 There was an error while checking the adapter.
121 .It device is disabled
122 .Pp
123 The adapter is disabled.
124 .It resource allocation failed
125 .It irq allocation failed
126 .It irq setup failed
127 .Pp
128 The driver was unable to allocate resources for the device.
129 .El
130 .Ss Error messages due to DMA:
131 .Bl -diag
132 .It can't alloc command dma tag
133 .It can't alloc SG dma tag
134 .It can't alloc dma tag for statue queue
135 .It dmamap failed
136 .Pp
137 Failure to map or allocate DMA resources.
138 .El
139 .Ss Cache, buffer, and command errors:
140 .Bl -diag
141 .It failed to initialize command buffers
142 .It no mem for command slots!
143 .Pp
144 The
145 .Nm
146 driver will return
147 .Bq Er ENOMEM
148 in such cases.
149 .It ERROR: unable to get a command! can't flush cache!
150 .It ERROR: cache flush command failed!
151 .It ERROR: unable to get a command! can't update nvram
152 .It ERROR: nvram update command failed!
153 .It ERROR: unable to get a command! can't sync cache!
154 .It ERROR: cache sync command failed!
155 .It ERROR: unable to get a command! can't sync cache!
156 .It ERROR: etable command failed!
157 .El
158 .Sh COMPATIBILITY
159 Unlike many of the other
160 .Tn SCSI
161 devices in
162 .Dx ,
163 the
164 .Nm
165 driver does not use the
166 .Xr cam 4
167 .Tn SCSI
168 subsystem.
169 .Sh SEE ALSO
170 .Xr ch 4 ,
171 .Xr da 4 ,
172 .Xr sysctl 8
173 .Sh AUTHORS
174 The
175 .Nm
176 driver was written by
177 .An -nosplit
178 .An David Jefferys
179 and
180 .An Scott Long Aq scottl@FreeBSD.org .
181 .Pp
182 This manual page was written by
183 .An Tom Rhodes Aq trhodes@FreeBSD.org .