aafd34e1c03faa075a08532511aea7b01af9190d
[dragonfly.git] / share / man / man4 / mlx.4
1 .\"
2 .\" Copyright (c) 2000 Jeroen Ruigrok van der Werven
3 .\" Copyright (c) 2000 Michael Smith
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. The name of the author may not be used to endorse or promote products
12 .\"    derived from this software without specific prior written permission
13 .\"
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 .\"
25 .\" $FreeBSD: src/share/man/man4/mlx.4,v 1.3.2.5 2001/10/01 13:07:23 dd Exp $
26 .\" $DragonFly: src/share/man/man4/mlx.4,v 1.4 2007/05/13 18:33:56 swildner Exp $
27 .\"
28 .Dd April 10, 2000
29 .Dt MLX 4
30 .Os
31 .Sh NAME
32 .Nm mlx
33 .Nd Mylex DAC-family RAID driver
34 .Sh SYNOPSIS
35 .Cd device pci
36 .Cd device mlx
37 .Sh DESCRIPTION
38 The
39 .Nm
40 driver provides support for Mylex DAC-family PCI to SCSI RAID controllers,
41 including versions relabeled by Digital/Compaq.
42 Supported controllers include:
43 .Bl -bullet
44 .It
45 DAC960P
46 .It
47 DAC960PD
48 .It
49 DAC960PL
50 .It
51 DAC960PJ
52 .It
53 DAC960PG
54 .It
55 AcceleRAID 150
56 .It
57 AcceleRAID 250
58 .It
59 eXtremeRAID 1100
60 .El
61 .Pp
62 All major firmware revisions (2.x, 3.x, 4.x and 5.x) are supported, however
63 it is always advisable to upgrade to the most recent firmware
64 available for the controller.
65 .Pp
66 Compatible Mylex controllers not listed should work, but have not been
67 verified.
68 .Sh DIAGNOSTICS
69 .Ss Controller initialisation phase
70 .Bl -diag
71 .It mlx%d: controller initialisation in progress...
72 .It mlx%d: initialisation complete
73 .Pp
74 The controller firmware is performing/has completed initialisation.
75 .It mlx%d: physical drive %d:%d not responding
76 .Pp
77 The drive at channel:target is not responding; it may have failed or
78 been removed.
79 .It mlx%d: spinning up drives...
80 .Pp
81 Drive startup is in progress; this may take several minutes.
82 .It mlx%d: configuration checksum error
83 .Pp
84 The array configuration has become corrupted.
85 .It mlx%d: mirror race recovery in progress
86 .It mlx%d: mirror race on a critical system drive
87 .It mlx%d: mirror race recovery failed
88 .Pp
89 These error codes are undocumented.
90 .It mlx%d: physical drive %d:%d COD mismatch
91 .Pp
92 Configuration data on the drive at channel:target does not match the
93 rest of the array.
94 .It mlx%d: system drive installation aborted
95 .Pp
96 Errors occurred preventing one or more system drives from being configured.
97 .It mlx%d: new controller configuration found
98 .Pp
99 The controller has detected a configuration on disk which supersedes the
100 configuration in its nonvolatile memory.
101 It will reset and come up with the new configuration.
102 .It mlx%d: FATAL MEMORY PARITY ERROR
103 .Pp
104 Firmware detected a fatal memory error; the driver will not attempt to
105 attach to this controller.
106 .It mlx%d: unknown firmware initialisation error %x:%x:%x
107 .Pp
108 An unknown error occurred during initialisation; it will be ignored.
109 .El
110 .Ss Driver initialisation/shutdown phase:
111 .Bl -diag
112 .It mlx%d: can't allocate scatter/gather DMA tag
113 .It mlx%d: can't allocate buffer DMA tag
114 .It mlx%d: can't allocate s/g table
115 .It mlx%d: can't make initial s/g list mapping
116 .It mlx%d: can't make permanent s/g list mapping
117 .It mlx%d: can't allocate interrupt
118 .It mlx%d: can't set up interrupt
119 .Pp
120 A resource allocation error occurred while initialising the driver;
121 initialisation has failed and the driver will not attach to this
122 controller.
123 .It mlx%d: error fetching drive status
124 .Pp
125 The current status of all system drives could not be fetched; attachment
126 of system drives will be aborted.
127 .It mlx%d: device_add_child failed
128 .It mlx%d: bus_generic_attach returned %d
129 .Pp
130 Creation of the system drive instances failed; attachment of one or more
131 system drives may have been aborted.
132 .It mlxd%d: detaching...
133 .Pp
134 The indicated system drive is being detached.
135 .It mlxd%d: still open, can't detach
136 .Pp
137 The indicated system drive is still open or mounted;
138 the controller cannot be detached.
139 .It mlx%d: flushing cache...
140 .Pp
141 The controller cache is being flushed prior to detach or shutdown.
142 .El
143 .Ss Operational diagnostics:
144 .Bl -diag
145 .It mlx%d: ENQUIRY failed - %s
146 .It mlx%d: ENQUIRY2 failed
147 .It mlx%d: ENQUIRY_OLD failed
148 .It mlx%d: FLUSH failed - %s
149 .It mlx%d: CHECK ASYNC failed - %s
150 .It mlx%d: REBUILD ASYNC failed - %s
151 .It mlx%d: command failed - %s
152 .Pp
153 The controller rejected a command for the reason given.
154 .It mlx%d: I/O beyond end of unit (%u,%d > %u)
155 .It mlx%d: I/O error - %s
156 .Pp
157 An I/O error was reported by the controller.
158 .It mlx%d: periodic enquiry failed - %s
159 .Pp
160 An attempt to poll the controller for status failed for the reason given.
161 .It mlx%d: mlx_periodic_enquiry: unknown command %x
162 .Pp
163 The periodic status poll has issued a command which has become corrupted.
164 .It mlxd%d: drive offline
165 .It mlxd%d: drive online
166 .It mlxd%d: drive critical
167 .Pp
168 The system disk indicated has changed state.
169 .It mlx%d: physical drive %d:%d reset
170 .It mlx%d: physical drive %d:%d killed %s
171 .It "mlx%d: physical drive %d:%d error log: sense = %d asc = %x asq = %x"
172 .It "mlx%d:   info %4D csi %4D"
173 .Pp
174 The drive at channel:target has been reset, killed for the given reason,
175 or experienced a SCSI error.
176 .It mlx%d: unknown log message type %x
177 .It mlx%d: error reading message log - %s
178 .Pp
179 An error occurred while trying to read the controller's message log.
180 .It mlxd%d: consistency check started
181 .It mlx%d: consistency check completed
182 .Pp
183 A user-initiated consistency check has started/completed.
184 .It mlx%d: drive rebuild started for %d:%d
185 .It mlx%d: drive rebuild completed
186 .Pp
187 A user-initiated physical drive rebuild has started/completed.
188 .It mlx%d: background check/rebuild operation started
189 .It mlx%d: background check/rebuild operation completed
190 .Pp
191 An automatic system drive consistency check
192 or physical drive rebuild has started/completed.
193 .It mlx%d: channel %d pausing for %d seconds
194 .It mlx%d: channel %d resuming
195 .It mlx%d: pause command failed - %s
196 .It mlx%d: pause failed for channel %d
197 .It mlx%d: resume command failed - %s
198 .It mlx%d: resume failed for channel %d
199 .Pp
200 Controller/channel pause operation notification.
201 (Channel pause is not currently supported on any controller.)
202 .It mlx%d: controller wedged (not taking commands)
203 .Pp
204 The controller is not responding to attempts to submit new commands.
205 .It mlx%d: duplicate done event for slot %d
206 .It mlx%d: done event for nonbusy slot %d
207 .Pp
208 Corruption has occurred in either the controller's onboard list of commands
209 or in the driver.
210 .El
211 .Sh SEE ALSO
212 .Xr mlxcontrol 8
213 .Sh AUTHORS
214 .An -nosplit
215 The
216 .Nm
217 driver was written by
218 .An Michael Smith
219 .Aq msmith@FreeBSD.org .
220 .Pp
221 This manual page was written by
222 .An Jeroen Ruigrok van der Werven
223 .Aq asmodai@FreeBSD.org
224 and
225 .An Michael Smith
226 .Aq msmith@FreeBSD.org .
227 .Sh BUGS
228 The driver does not yet support the version 6.x firmware as found in the
229 AcceleRAID 352 and eXtremeRAID 2000 and 3000 products.