usr.sbin/mpsutil/mpsutil.8

   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 enclosures
  55 .Nm
  56 .Op Fl u Ar unit
  57 .Cm show expanders
  58 .Nm
  59 .Op Fl u Ar unit
  60 .Cm show iocfacts
  61 .Nm
  62 .Op Fl u Ar unit
  63 .Cm set ncq
  64 .Op Ar enable Ns | Ns Ar disable
  65 .Nm
  66 .Op Fl u Ar unit
  67 .Cm flash save
  68 .Op Ar firmware Ns | Ns Ar bios
  69 .Op Ar file
  70 .Nm
  71 .Op Fl u Ar unit
  72 .Cm flash update
  73 .Op Ar firmware Ns | Ns Ar bios
  74 .Ar file
  75 .Sh DESCRIPTION
  76 The
  77 .Nm
  78 utility can be used to display or modify various parameters on LSI
  79 Fusion-MPS 2 controllers.
  80 .Pp
  81 The
  82 .Nm mprutil
  83 utility can be used to display or modify various parameters on LSI
  84 Fusion-MPS 3 controllers.
  85 .Pp
  86 Both the
  87 .Nm mprutil
  88 and
  89 .Nm
  90 commands behave identically.
  91 .Pp
  92 Each invocation of
  93 .Nm
  94 consists of zero or more global options followed by a command.
  95 Commands may support additional optional or required arguments after the
  96 command.
  97 .Pp
  98 Currently one global option is supported:
  99 .Bl -tag -width indent
 100 .It Fl u Ar unit
 101 .Ar unit
 102 specifies the unit of the controller to work with.
 103 If no unit is specified,
 104 then unit 0 is used.
 105 .El
 106 .Pp
 107 The
 108 .Nm
 109 utility supports several different groups of commands.
 110 The first group of commands provide information about the controller.
 111 The second group of commands are used to manager controller-wide operations.
 112 .Pp
 113 The informational commands include:
 114 .Bl -tag -width indent
 115 .It Cm version
 116 Displays the version of
 117 .Nm .
 118 .It Cm show adapter
 119 Displays information about the controller such as the model number or firmware
 120 version.
 121 .It Cm show adapters
 122 Displays a summary of all adapters.
 123 .It Cm show all
 124 Displays all devices, expanders and enclosures.
 125 .It Cm show devices
 126 Displays all devices.
 127 .It Cm show expanders
 128 Displays all expanders.
 129 .It Cm show enclosures
 130 Displays all enclosures.
 131 .It Cm show iocfacts
 132 Displays IOC Facts messages.
 133 .It Cm show cfgpage page Oo Ar num Oc Op Ar addr
 134 Dump raw config page in hex.
 135 .El
 136 .Pp
 137 Controller management commands include:
 138 .Bl -tag -width indent
 139 .It Cm set ncq Oo Ar enable Ns | Ns Ar disable Oc
 140 Enables or disables NCQ in the NVRAM of the card.
 141 .It Cm flash save Oo Ar firmware Ns | Ns Ar bios Oc Op Ar file
 142 Save the
 143 .Ar firmware
 144 or
 145 .Ar bios
 146 from the controller into a local
 147 .Ar file .
 148 If no
 149 .Ar file
 150 is specified then the file will be named
 151 .Pa firmware
 152 or
 153 .Pa bios .
 154 .It Cm flash update Oo Ar firmware Ns | Ns Ar bios Oc Ar file
 155 Replace the
 156 .Ar firmware
 157 or
 158 .Ar bios
 159 from the controller with the one specified via
 160 .Ar file .
 161 .El
 162 .Sh SEE ALSO
 163 .Xr mpr 4 ,
 164 .Xr mps 4
 165 .Sh HISTORY
 166 The
 167 .Nm
 168 utility first appeared in
 169 .Fx 11.0 .
 170 .Sh TODO
 171 Flash operations (save/update) are not supported on big-endian architectures.