xref: /freebsd/usr.sbin/mpsutil/mpsutil.8 (revision a259b98fa211ed87bfee58c575de4e2de94ee0fa)
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.Dd May 7, 2021
26.Dt MPSUTIL 8
27.Os
28.Sh NAME
29.Nm mpsutil ,
30.Nm mprutil
31.Nd Utility for managing LSI Fusion-MPT 2/3 controllers
32.Sh SYNOPSIS
33.Nm
34.Cm version
35.Nm
36.Op Fl u Ar unit
37.Cm show adapter
38.Nm
39.Op Fl u Ar unit
40.Cm show adapters
41.Nm
42.Op Fl u Ar unit
43.Cm show all
44.Nm
45.Op Fl u Ar unit
46.Cm show cfgpage page
47.Op Ar num
48.Op Ar addr
49.Nm
50.Op Fl u Ar unit
51.Cm show devices
52.Nm
53.Op Fl u Ar unit
54.Cm show discovery
55.Nm
56.Op Fl u Ar unit
57.Cm show enclosures
58.Nm
59.Op Fl u Ar unit
60.Cm show expanders
61.Nm
62.Op Fl u Ar unit
63.Cm show iocfacts
64.Nm
65.Op Fl u Ar unit
66.Cm set ncq
67.Op Ar enable Ns | Ns Ar disable
68.Nm
69.Op Fl u Ar unit
70.Cm flash save
71.Op Ar firmware Ns | Ns Ar bios
72.Op Ar file
73.Nm
74.Op Fl u Ar unit
75.Cm flash update
76.Op Ar firmware Ns | Ns Ar bios
77.Ar file
78.Sh DESCRIPTION
79The
80.Nm
81utility can be used to display or modify various parameters on LSI
82Fusion-MPS 2 controllers.
83.Pp
84The
85.Nm mprutil
86utility can be used to display or modify various parameters on LSI
87Fusion-MPS 3 controllers.
88.Pp
89Both the
90.Nm mprutil
91and
92.Nm
93commands behave identically.
94.Pp
95Each invocation of
96.Nm
97consists of zero or more global options followed by a command.
98Commands may support additional optional or required arguments after the
99command.
100.Pp
101Currently one global option is supported:
102.Bl -tag -width indent
103.It Fl u Ar unit
104.Ar unit
105specifies the unit of the controller to work with.
106If no unit is specified,
107then unit 0 is used.
108.El
109.Pp
110The
111.Nm
112utility supports several different groups of commands.
113The first group of commands provide information about the controller.
114The second group of commands are used to manager controller-wide operations.
115.Pp
116The informational commands include:
117.Bl -tag -width indent
118.It Cm version
119Displays the version of
120.Nm .
121.It Cm show adapter
122Displays information about the controller such as the model number or firmware
123version.
124.It Cm show adapters
125Displays a summary of all adapters.
126.It Cm show all
127Displays all devices, expanders and enclosures.
128.It Cm show devices
129Displays all devices.
130.It Cm show discovery
131Displays the firmware DiscoveryStatus field for each PHY
132.Po Dq SAS IO Unit Page 0 Pc
133and the AccessStatus field for each device
134.Po Dq SAS Device Page 0 Pc .
135Entries with a nonzero DiscoveryStatus, a non-Ok AccessStatus, or a PHY
136still showing discovery in progress are marked
137.Dq SUSPECT .
138Useful for finding which PHY or device a firmware discovery stall was
139attributed to, since these fields aren't otherwise exposed and can remain
140set after the boot completes.
141.It Cm show expanders
142Displays all expanders.
143.It Cm show enclosures
144Displays all enclosures.
145.It Cm show iocfacts
146Displays IOC Facts messages.
147.It Cm show cfgpage page Oo Ar num Oc Op Ar addr
148Dump raw config page in hex.
149.El
150.Pp
151Controller management commands include:
152.Bl -tag -width indent
153.It Cm set ncq Oo Ar enable Ns | Ns Ar disable Oc
154Enables or disables NCQ in the NVRAM of the card.
155.It Cm flash save Oo Ar firmware Ns | Ns Ar bios Oc Op Ar file
156Save the
157.Ar firmware
158or
159.Ar bios
160from the controller into a local
161.Ar file .
162If no
163.Ar file
164is specified then the file will be named
165.Pa firmware
166or
167.Pa bios .
168.It Cm flash update Oo Ar firmware Ns | Ns Ar bios Oc Ar file
169Replace the
170.Ar firmware
171or
172.Ar bios
173from the controller with the one specified via
174.Ar file .
175.El
176.Sh SEE ALSO
177.Xr mpr 4 ,
178.Xr mps 4
179.Sh HISTORY
180The
181.Nm
182utility first appeared in
183.Fx 11.0 .
184.Sh TODO
185Flash operations (save/update) are not supported on big-endian architectures.
186