xref: /freebsd/usr.sbin/mpsutil/mpsutil.8 (revision 1603881667360c015f6685131f2f25474fa67a72)
1.\"
2.\" Copyright (c) Baptiste Daroussin <bapt@FreeBSD.org>
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd May 7, 2021
28.Dt MPSUTIL 8
29.Os
30.Sh NAME
31.Nm mpsutil ,
32.Nm mprutil
33.Nd Utility for managing LSI Fusion-MPT 2/3 controllers
34.Sh SYNOPSIS
35.Nm
36.Cm version
37.Nm
38.Op Fl u Ar unit
39.Cm show adapter
40.Nm
41.Op Fl u Ar unit
42.Cm show adapters
43.Nm
44.Op Fl u Ar unit
45.Cm show all
46.Nm
47.Op Fl u Ar unit
48.Cm show cfgpage page
49.Op Ar num
50.Op Ar addr
51.Nm
52.Op Fl u Ar unit
53.Cm show devices
54.Nm
55.Op Fl u Ar unit
56.Cm show enclosures
57.Nm
58.Op Fl u Ar unit
59.Cm show expanders
60.Nm
61.Op Fl u Ar unit
62.Cm show iocfacts
63.Nm
64.Op Fl u Ar unit
65.Cm set ncq
66.Op Ar enable Ns | Ns Ar disable
67.Nm
68.Op Fl u Ar unit
69.Cm flash save
70.Op Ar firmware Ns | Ns Ar bios
71.Op Ar file
72.Nm
73.Op Fl u Ar unit
74.Cm flash update
75.Op Ar firmware Ns | Ns Ar bios
76.Ar file
77.Sh DESCRIPTION
78The
79.Nm
80utility can be used to display or modify various parameters on LSI
81Fusion-MPS 2 controllers.
82.Pp
83The
84.Nm mprutil
85utility can be used to display or modify various parameters on LSI
86Fusion-MPS 3 controllers.
87.Pp
88The
89.Nm mprutil
90utility behave identically to
91.Nm .
92(same program)
93.Pp
94Each invocation of
95.Nm
96consists of zero or more global options followed by a command.
97Commands may support additional optional or required arguments after the
98command.
99.Pp
100Currently one global option is supported:
101.Bl -tag -width indent
102.It Fl u Ar unit
103.Ar unit
104specifies the unit of the controller to work with.
105If no unit is specified,
106then unit 0 is used.
107.El
108.Pp
109The
110.Nm
111utility supports several different groups of commands.
112The first group of commands provide information about the controller.
113The second group of commands are used to manager controller-wide operations.
114.Pp
115The informational commands include:
116.Bl -tag -width indent
117.It Cm version
118Displays the version of
119.Nm .
120.It Cm show adapter
121Displays information about the controller such as the model number or firmware
122version.
123.It Cm show adapters
124Displays a summary of all adapters.
125.It Cm show all
126Displays all devices, expanders and enclosures.
127.It Cm show devices
128Displays all devices.
129.It Cm show expanders
130Displays all expanders.
131.It Cm show enclosures
132Displays all enclosures.
133.It Cm show iocfacts
134Displays IOC Facts messages.
135.It Cm show cfgpage page Oo Ar num Oc Op Ar addr
136Dump raw config page in hex.
137.El
138.Pp
139Controller management commands include:
140.Bl -tag -width indent
141.It Cm set ncq Oo Ar enable Ns | Ns Ar disable Oc
142Enables or disables NCQ in the NVRAM of the card.
143.It Cm flash save Oo Ar firmware Ns | Ns Ar bios Oc Op Ar file
144Save the
145.Ar firmware
146or
147.Ar bios
148from the controller into a local
149.Ar file .
150If no
151.Ar file
152is specified then the file will be named
153.Pa firmware
154or
155.Pa bios .
156.It Cm flash update Oo Ar firmware Ns | Ns Ar bios Oc Ar file
157Replace the
158.Ar firmware
159or
160.Ar bios
161from the controller with the one specified via
162.Ar file .
163.El
164.Sh SEE ALSO
165.Xr mpr 4 ,
166.Xr mps 4
167.Sh HISTORY
168The
169.Nm
170utility first appeared in
171.Fx 11.0 .
172.Sh TODO
173Flash operations (save/update) are not supported on big-endian architectures.
174.Pp
175