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