Remove some more %D remains here and there.
[dragonfly.git] / share / man / man4 / mly.4
CommitLineData
984263bc
MD
1.\"
2.\" Copyright (c) 2000 Michael Smith
3.\" Copyright (c) 2000 BSDi
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.\"
2e4b8d04 25.\" $FreeBSD: src/share/man/man4/mly.4,v 1.10 2006/05/20 09:39:28 brueffer Exp $
984263bc 26.\"
2e4b8d04 27.Dd August 10, 2004
984263bc
MD
28.Dt MLY 4
29.Os
30.Sh NAME
31.Nm mly
32.Nd Mylex AcceleRAID/eXtremeRAID family driver
33.Sh SYNOPSIS
2e4b8d04
PA
34To compile this driver into the kernel,
35place the following lines in your
36kernel configuration file:
37.Bd -ragged -offset indent
38.Cd "device pci"
39.Cd "device scbus"
40.Cd "device da"
41.Cd "device mly"
42.Ed
43.Pp
44Alternatively, to load the driver as a
45module at boot time, place the following line in
46.Xr loader.conf 5 :
47.Bd -literal -offset indent
48mly_load="YES"
49.Ed
984263bc
MD
50.Sh DESCRIPTION
51The
52.Nm
53driver provides support for Mylex AcceleRAID and eXtremeRAID-family
54PCI to SCSI RAID controllers with version 6.00 and later
55firmware.
2e4b8d04
PA
56.Pp
57Logical devices (array drives) attached to the controller are presented
58to the SCSI subsystem as though they were direct-access devices on a
59virtual SCSI bus.
60Physical devices which are not claimed by a logical
61device are presented on SCSI channels which match the physical channels
62on the controller.
63.Sh HARDWARE
64Controllers supported by the
65.Nm
66driver include:
67.Pp
68.Bl -bullet -compact
984263bc 69.It
2e4b8d04 70Mylex AcceleRAID 160
984263bc 71.It
2e4b8d04 72Mylex AcceleRAID 170
984263bc 73.It
2e4b8d04 74Mylex AcceleRAID 352
984263bc 75.It
2e4b8d04 76Mylex eXtremeRAID 2000
984263bc 77.It
2e4b8d04 78Mylex eXtremeRAID 3000
984263bc
MD
79.El
80.Pp
81Compatible Mylex controllers not listed should work, but have not been
82verified.
984263bc
MD
83.Sh DIAGNOSTICS
84.Ss Controller initialisation phase
85.Bl -diag
86.It "mly%d: controller initialisation started"
87.It "mly%d: initialisation complete"
88.Pp
89The controller firmware has started initialisation.
90Normally this process is performed by the controller BIOS,
91but the driver may need
92to do this in cases where the BIOS has failed, or is not compatible
2e4b8d04 93(e.g.\& on non-x86 systems).
984263bc
MD
94.It "mly%d: drive spinup in progress"
95.Pp
96Drive startup is in progress; this may take several minutes.
97.It "mly%d: mirror race recovery failed, one or more drives offline"
98.It "mly%d: mirror race recovery in progress"
99.It "mly%d: mirror race recovery on a critical drive"
100.Pp
101These error codes are undocumented.
102.It "mly%d: FATAL MEMORY PARITY ERROR"
103.Pp
104Firmware detected a fatal memory error; the driver will not attempt to
105attach to this controller.
106.It "mly%d: unknown initialisation code %x"
107.Pp
108An unknown error occurred during initialisation; it will be ignored.
109.El
110.Ss Driver initialisation/shutdown phase
111.Bl -diag
112.It "mly%d: can't enable busmaster feature"
113.It "mly%d: memory window not available"
114.It "mly%d: can't allocate register window"
115.It "mly%d: can't allocate interrupt"
116.It "mly%d: can't set up interrupt"
117.Pp
118The system's PCI BIOS has not correctly configured the controller's
119PCI interface; initialisation has failed and the driver will not
120attach to this controller.
121.It "mly%d: can't allocate parent DMA tag"
122.It "mly%d: can't allocate buffer DMA tag"
123.It "mly%d: can't allocate command packet DMA tag"
124.It "mly%d: can't allocate scatter/gather DMA tag"
125.It "mly%d: can't allocate s/g table"
126.It "mly%d: can't allocate memory mailbox DMA tag"
127.It "mly%d: can't allocate memory mailbox"
128.Pp
129A resource allocation error occurred while initialising the driver;
130initialisation has failed and the driver will not attach to this
131controller.
132.It "mly%d: BTL rescan result corrupted"
133.Pp
134The results of a scan for an attached device were corrupted.
135One or more devices may not be correctly reported.
136.It "mly%d: flushing cache..."
137.Pp
138The controller cache is being flushed prior to detach or shutdown.
139.El
140.Ss Operational diagnostics
141.Bl -diag
142.It "mly%d: physical device %d:%d online"
143.It "mly%d: physical device %d:%d standby"
144.It "mly%d: physical device %d:%d automatic rebuild started"
145.It "mly%d: physical device %d:%d manual rebuild started"
146.It "mly%d: physical device %d:%d rebuild completed"
147.It "mly%d: physical device %d:%d rebuild cancelled"
148.It "mly%d: physical device %d:%d rebuild failed for unknown reasons"
149.It "mly%d: physical device %d:%d rebuild failed due to new physical device"
150.It "mly%d: physical device %d:%d rebuild failed due to logical drive failure"
151.It "mly%d: physical device %d:%d found"
152.It "mly%d: physical device %d:%d gone"
153.It "mly%d: physical device %d:%d unconfigured"
154.It "mly%d: physical device %d:%d expand capacity started"
155.It "mly%d: physical device %d:%d expand capacity completed"
156.It "mly%d: physical device %d:%d expand capacity failed"
157.It "mly%d: physical device %d:%d parity error"
158.It "mly%d: physical device %d:%d soft error"
159.It "mly%d: physical device %d:%d miscellaneous error"
160.It "mly%d: physical device %d:%d reset"
161.It "mly%d: physical device %d:%d active spare found"
162.It "mly%d: physical device %d:%d warm spare found"
163.It "mly%d: physical device %d:%d initialization started"
164.It "mly%d: physical device %d:%d initialization completed"
165.It "mly%d: physical device %d:%d initialization failed"
166.It "mly%d: physical device %d:%d initialization cancelled"
167.It "mly%d: physical device %d:%d write recovery failed"
168.It "mly%d: physical device %d:%d scsi bus reset failed"
169.It "mly%d: physical device %d:%d double check condition"
170.It "mly%d: physical device %d:%d device cannot be accessed"
171.It "mly%d: physical device %d:%d gross error on scsi processor"
172.It "mly%d: physical device %d:%d bad tag from device"
173.It "mly%d: physical device %d:%d command timeout"
174.It "mly%d: physical device %d:%d system reset"
175.It "mly%d: physical device %d:%d busy status or parity error"
176.It "mly%d: physical device %d:%d host set device to failed state"
177.It "mly%d: physical device %d:%d selection timeout"
178.It "mly%d: physical device %d:%d scsi bus phase error"
179.It "mly%d: physical device %d:%d device returned unknown status"
180.It "mly%d: physical device %d:%d device not ready"
181.It "mly%d: physical device %d:%d device not found at startup"
182.It "mly%d: physical device %d:%d COD write operation failed"
183.It "mly%d: physical device %d:%d BDT write operation failed"
184.It "mly%d: physical device %d:%d missing at startup"
185.It "mly%d: physical device %d:%d start rebuild failed due to physical drive too small"
186.It "mly%d: physical device %d:%d sense data received"
187.It "mly%d: sense key %d asc %02x ascq %02x"
e707c6f3 188.It "mly%d: info XX:XX:XX:XX csi XX:XX:XX:XX"
984263bc
MD
189.It "mly%d: physical device %d:%d offline"
190.It "mly%d: sense key %d asc %02x ascq %02x"
e707c6f3 191.It "mly%d: info XX:XX:XX:XX csi XX:XX:XX:XX"
984263bc
MD
192.Pp
193The reported event refers to the physical device at the given channel:target
194address.
195.It "mly%d: logical device %d (%s) consistency check started"
196.It "mly%d: logical device %d (%s) consistency check completed"
197.It "mly%d: logical device %d (%s) consistency check cancelled"
198.It "mly%d: logical device %d (%s) consistency check completed with errors"
199.It "mly%d: logical device %d (%s) consistency check failed due to logical drive failure"
200.It "mly%d: logical device %d (%s) consistency check failed due to physical device failure"
201.It "mly%d: logical device %d (%s) automatic rebuild started"
202.It "mly%d: logical device %d (%s) manual rebuild started"
203.It "mly%d: logical device %d (%s) rebuild completed"
204.It "mly%d: logical device %d (%s) rebuild cancelled"
205.It "mly%d: logical device %d (%s) rebuild failed for unknown reasons"
206.It "mly%d: logical device %d (%s) rebuild failed due to new physical device"
207.It "mly%d: logical device %d (%s) rebuild failed due to logical drive failure"
208.It "mly%d: logical device %d (%s) offline"
209.It "mly%d: logical device %d (%s) critical"
210.It "mly%d: logical device %d (%s) online"
211.It "mly%d: logical device %d (%s) initialization started"
212.It "mly%d: logical device %d (%s) initialization completed"
213.It "mly%d: logical device %d (%s) initialization cancelled"
214.It "mly%d: logical device %d (%s) initialization failed"
215.It "mly%d: logical device %d (%s) found"
216.It "mly%d: logical device %d (%s) gone"
217.It "mly%d: logical device %d (%s) expand capacity started"
218.It "mly%d: logical device %d (%s) expand capacity completed"
219.It "mly%d: logical device %d (%s) expand capacity failed"
220.It "mly%d: logical device %d (%s) bad block found"
221.It "mly%d: logical device %d (%s) size changed"
222.It "mly%d: logical device %d (%s) type changed"
223.It "mly%d: logical device %d (%s) bad data block found"
224.It "mly%d: logical device %d (%s) read of data block in bdt"
225.It "mly%d: logical device %d (%s) write back data for disk block lost"
226.Pp
227The event report will include the name of the SCSI device which has
228attached to the device if possible.
229.It "mly%d: enclosure %d fan %d failed"
230.It "mly%d: enclosure %d fan %d ok"
231.It "mly%d: enclosure %d fan %d not present"
232.It "mly%d: enclosure %d power supply %d failed"
233.It "mly%d: enclosure %d power supply %d ok"
234.It "mly%d: enclosure %d power supply %d not present"
235.It "mly%d: enclosure %d temperature sensor %d failed"
236.It "mly%d: enclosure %d temperature sensor %d critical"
237.It "mly%d: enclosure %d temperature sensor %d ok"
238.It "mly%d: enclosure %d temperature sensor %d not present"
239.It "mly%d: enclosure %d unit %d access critical"
240.It "mly%d: enclosure %d unit %d access ok"
241.It "mly%d: enclosure %d unit %d access offline"
242.Pp
243These events refer to external enclosures by number.
244The driver does not attempt to name the enclosures.
245.It "mly%d: controller cache write back error"
246.It "mly%d: controller battery backup unit found"
247.It "mly%d: controller battery backup unit charge level low"
248.It "mly%d: controller battery backup unit charge level ok"
249.It "mly%d: controller installation aborted"
250.It "mly%d: controller mirror race recovery in progress"
251.It "mly%d: controller mirror race on critical drive"
252.It "mly%d: controller memory soft ecc error"
253.It "mly%d: controller memory hard ecc error"
254.It "mly%d: controller battery backup unit failed"
255.Pp
256These events report controller status changes.
257.El
984263bc
MD
258.Sh AUTHORS
259.An -nosplit
260The
261.Nm
262driver was written by
263.An Michael Smith
264.Aq msmith@FreeBSD.org .
265.Pp
266This manual page was written by
267.An Michael Smith
268.Aq msmith@FreeBSD.org .
ac561d34
SW
269.Sh BUGS
270The driver does not yet provide an external management interface.
271.Pp
272Enclosures are not named or otherwise identified in event messages.