Merge branch 'vendor/LIBPCAP'
[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 .\"
27 .Dd December 10, 2014
28 .Dt MLX 4
29 .Os
30 .Sh NAME
31 .Nm mlx
32 .Nd Mylex DAC-family RAID driver
33 .Sh SYNOPSIS
34 .Cd device pci
35 .Cd device mlx
36 .Sh DESCRIPTION
37 The
38 .Nm
39 driver provides support for Mylex DAC-family PCI to SCSI RAID controllers,
40 including versions relabeled by Digital/Compaq.
41 Supported controllers include:
42 .Bl -bullet
43 .It
44 DAC960P
45 .It
46 DAC960PD
47 .It
48 DAC960PL
49 .It
50 DAC960PJ
51 .It
52 DAC960PG
53 .It
54 AcceleRAID 150
55 .It
56 AcceleRAID 250
57 .It
58 eXtremeRAID 1100
59 .El
60 .Pp
61 All major firmware revisions (2.x, 3.x, 4.x and 5.x) are supported, however
62 it is always advisable to upgrade to the most recent firmware
63 available for the controller.
64 .Pp
65 Compatible Mylex controllers not listed should work, but have not been
66 verified.
67 .Sh FILES
68 .Bl -tag -width ".Pa /dev/mlxdX" -compact
69 .It Pa /dev/mlxdX
70 .Nm
71 device nodes
72 .El
73 .Sh DIAGNOSTICS
74 .Ss Controller initialisation phase
75 .Bl -diag
76 .It mlx%d: controller initialisation in progress...
77 .It mlx%d: initialisation complete
78 .Pp
79 The controller firmware is performing/has completed initialisation.
80 .It mlx%d: physical drive %d:%d not responding
81 .Pp
82 The drive at channel:target is not responding; it may have failed or
83 been removed.
84 .It mlx%d: spinning up drives...
85 .Pp
86 Drive startup is in progress; this may take several minutes.
87 .It mlx%d: configuration checksum error
88 .Pp
89 The array configuration has become corrupted.
90 .It mlx%d: mirror race recovery in progress
91 .It mlx%d: mirror race on a critical system drive
92 .It mlx%d: mirror race recovery failed
93 .Pp
94 These error codes are undocumented.
95 .It mlx%d: physical drive %d:%d COD mismatch
96 .Pp
97 Configuration data on the drive at channel:target does not match the
98 rest of the array.
99 .It mlx%d: system drive installation aborted
100 .Pp
101 Errors occurred preventing one or more system drives from being configured.
102 .It mlx%d: new controller configuration found
103 .Pp
104 The controller has detected a configuration on disk which supersedes the
105 configuration in its nonvolatile memory.
106 It will reset and come up with the new configuration.
107 .It mlx%d: FATAL MEMORY PARITY ERROR
108 .Pp
109 Firmware detected a fatal memory error; the driver will not attempt to
110 attach to this controller.
111 .It mlx%d: unknown firmware initialisation error %x:%x:%x
112 .Pp
113 An unknown error occurred during initialisation; it will be ignored.
114 .El
115 .Ss Driver initialisation/shutdown phase:
116 .Bl -diag
117 .It mlx%d: can't allocate scatter/gather DMA tag
118 .It mlx%d: can't allocate buffer DMA tag
119 .It mlx%d: can't allocate s/g table
120 .It mlx%d: can't make initial s/g list mapping
121 .It mlx%d: can't make permanent s/g list mapping
122 .It mlx%d: can't allocate interrupt
123 .It mlx%d: can't set up interrupt
124 .Pp
125 A resource allocation error occurred while initialising the driver;
126 initialisation has failed and the driver will not attach to this
127 controller.
128 .It mlx%d: error fetching drive status
129 .Pp
130 The current status of all system drives could not be fetched; attachment
131 of system drives will be aborted.
132 .It mlx%d: device_add_child failed
133 .It mlx%d: bus_generic_attach returned %d
134 .Pp
135 Creation of the system drive instances failed; attachment of one or more
136 system drives may have been aborted.
137 .It mlxd%d: detaching...
138 .Pp
139 The indicated system drive is being detached.
140 .It mlxd%d: still open, can't detach
141 .Pp
142 The indicated system drive is still open or mounted;
143 the controller cannot be detached.
144 .It mlx%d: flushing cache...
145 .Pp
146 The controller cache is being flushed prior to detach or shutdown.
147 .El
148 .Ss Operational diagnostics:
149 .Bl -diag
150 .It mlx%d: ENQUIRY failed - %s
151 .It mlx%d: ENQUIRY2 failed
152 .It mlx%d: ENQUIRY_OLD failed
153 .It mlx%d: FLUSH failed - %s
154 .It mlx%d: CHECK ASYNC failed - %s
155 .It mlx%d: REBUILD ASYNC failed - %s
156 .It mlx%d: command failed - %s
157 .Pp
158 The controller rejected a command for the reason given.
159 .It mlx%d: I/O beyond end of unit (%u,%d > %u)
160 .It mlx%d: I/O error - %s
161 .Pp
162 An I/O error was reported by the controller.
163 .It mlx%d: periodic enquiry failed - %s
164 .Pp
165 An attempt to poll the controller for status failed for the reason given.
166 .It mlx%d: mlx_periodic_enquiry: unknown command %x
167 .Pp
168 The periodic status poll has issued a command which has become corrupted.
169 .It mlxd%d: drive offline
170 .It mlxd%d: drive online
171 .It mlxd%d: drive critical
172 .Pp
173 The system disk indicated has changed state.
174 .It mlx%d: physical drive %d:%d reset
175 .It mlx%d: physical drive %d:%d killed %s
176 .It "mlx%d: physical drive %d:%d error log: sense = %d asc = %x asq = %x"
177 .It "mlx%d:   info XX:XX:XX:XX csi XX:XX:XX:XX"
178 .Pp
179 The drive at channel:target has been reset, killed for the given reason,
180 or experienced a SCSI error.
181 .It mlx%d: unknown log message type %x
182 .It mlx%d: error reading message log - %s
183 .Pp
184 An error occurred while trying to read the controller's message log.
185 .It mlxd%d: consistency check started
186 .It mlx%d: consistency check completed
187 .Pp
188 A user-initiated consistency check has started/completed.
189 .It mlx%d: drive rebuild started for %d:%d
190 .It mlx%d: drive rebuild completed
191 .Pp
192 A user-initiated physical drive rebuild has started/completed.
193 .It mlx%d: background check/rebuild operation started
194 .It mlx%d: background check/rebuild operation completed
195 .Pp
196 An automatic system drive consistency check
197 or physical drive rebuild has started/completed.
198 .It mlx%d: channel %d pausing for %d seconds
199 .It mlx%d: channel %d resuming
200 .It mlx%d: pause command failed - %s
201 .It mlx%d: pause failed for channel %d
202 .It mlx%d: resume command failed - %s
203 .It mlx%d: resume failed for channel %d
204 .Pp
205 Controller/channel pause operation notification.
206 (Channel pause is not currently supported on any controller.)
207 .It mlx%d: controller wedged (not taking commands)
208 .Pp
209 The controller is not responding to attempts to submit new commands.
210 .It mlx%d: duplicate done event for slot %d
211 .It mlx%d: done event for nonbusy slot %d
212 .Pp
213 Corruption has occurred in either the controller's onboard list of commands
214 or in the driver.
215 .El
216 .Sh SEE ALSO
217 .Xr mlxcontrol 8
218 .Sh AUTHORS
219 .An -nosplit
220 The
221 .Nm
222 driver was written by
223 .An Michael Smith Aq Mt msmith@FreeBSD.org .
224 .Pp
225 This manual page was written by
226 .An Jeroen Ruigrok van der Werven Aq Mt asmodai@FreeBSD.org
227 and
228 .An Michael Smith Aq Mt msmith@FreeBSD.org .
229 .Sh BUGS
230 The driver does not yet support the version 6.x firmware as found in the
231 AcceleRAID 352 and eXtremeRAID 2000 and 3000 products.