usr.sbin/cpucontrol/cpucontrol.8

   1 .\" Copyright (c) 2006, 2008 Stanislav Sedov <stas@FreeBSD.org>.
   2 .\" All rights reserved.
   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 September 30, 2017
  28 .Dt CPUCONTROL 8
  29 .Os
  30 .Sh NAME
  31 .Nm cpucontrol
  32 .Nd control utility for the
  33 .Xr cpuctl 4
  34 device
  35 .Sh SYNOPSIS
  36 .Nm
  37 .Op Fl v
  38 .Fl m Ar msr
  39 .Bk
  40 .Ar device
  41 .Ek
  42 .Nm
  43 .Op Fl v
  44 .Fl m Ar msr Ns = Ns Ar value
  45 .Bk
  46 .Ar device
  47 .Ek
  48 .Nm
  49 .Op Fl v
  50 .Fl m Ar msr Ns &= Ns Ar mask
  51 .Bk
  52 .Ar device
  53 .Ek
  54 .Nm
  55 .Op Fl v
  56 .Fl m Ar msr Ns |= Ns Ar mask
  57 .Bk
  58 .Ar device
  59 .Ek
  60 .Nm
  61 .Op Fl v
  62 .Fl i Ar level
  63 .Bk
  64 .Ar device
  65 .Ek
  66 .Nm
  67 .Op Fl v
  68 .Fl i Ar level,level_type
  69 .Bk
  70 .Ar device
  71 .Ek
  72 .Nm
  73 .Op Fl vn
  74 .Op Fl d Ar datadir
  75 .Fl u
  76 .Bk
  77 .Ar device
  78 .Ek
  79 .Sh DESCRIPTION
  80 The
  81 .Nm
  82 utility can be used to read and write arbitrary machine-specific
  83 CPU registers via the
  84 .Xr cpuctl 4
  85 special device.
  86 It can also be used to apply CPU firmware updates.
  87 .Pp
  88 The following options are available:
  89 .Bl -tag -width indent
  90 .It Fl d Ar datadir
  91 Directory paths where to look for microcode images.
  92 The option can be specified multiple times.
  93 The paths are added in order of the options appearance on the command
  94 line, default directories are appended after the user-supplied paths.
  95 .It Fl n
  96 Do not look for the microcode images in the standard directories.
  97 Currently standard directory to look for the microcode update files is
  98 .Pa /usr/local/share/cpucontrol .
  99 .It Fl m Ar msr
 100 Show value of the specified MSR.
 101 MSR register number should be given as a hexadecimal number.
 102 The high word is printed first, then the low word is printed second.
 103 .It Fl m Ar msr Ns = Ns Ar value
 104 Store the
 105 .Ar value
 106 in the specified MSR register.
 107 The
 108 .Ar value
 109 argument can be prefixed with ~ operator.
 110 In this case the inverted value of argument will be stored in the register.
 111 .It Fl m Ar msr Ns &= Ns Ar mask
 112 Store the result of bitwise AND operation between
 113 .Ar mask
 114 and the current MSR value in the MSR register.
 115 The
 116 .Ar mask
 117 argument can be prefixed with ~ operator.
 118 In this case the inverted value of mask will be used.
 119 .It Fl m Ar msr Ns |= Ns Ar mask
 120 Store the result of bitwise OR operation between
 121 .Ar mask
 122 and the current MSR value in the MSR register.
 123 The
 124 .Ar mask
 125 argument can be prefixed with ~ operator.
 126 In this case the inverted value of mask will be used.
 127 .It Fl i Ar level
 128 Retrieve CPUID info.
 129 Level should be given as a hex number.
 130 .It Fl i Ar level,level_type
 131 Retrieve CPUID info.
 132 Level and level_type should be given as hex numbers.
 133 .It Fl u
 134 Apply CPU firmware updates.
 135 The
 136 .Nm
 137 utility will walk through the configured data directories
 138 and apply all firmware updates available for this CPU.
 139 .It Fl v
 140 Increase the verbosity level.
 141 .It Fl h
 142 Show help message.
 143 .El
 144 .Sh EXIT STATUS
 145 .Ex -std
 146 .Sh EXAMPLES
 147 The command
 148 .Pp
 149 .Dq Li "cpucontrol -m 0x10 /dev/cpuctl0"
 150 .Pp
 151 will read the contents of TSC MSR from CPU 0.
 152 .Pp
 153 To set the CPU 0 TSC MSR register value to 0x1 issue
 154 .Pp
 155 .Dq Li "cpucontrol -m 0x10=0x1 /dev/cpuctl0" .
 156 .Pp
 157 The following command will clear the second bit of TSC register:
 158 .Pp
 159 .Dq Li "cpucontrol -m 0x10&=~0x02 /dev/cpuctl0" .
 160 .Pp
 161 The following command will set the forth and second bit of TSC register:
 162 .Pp
 163 .Dq Li "cpucontrol -m 0x10|=0x0a /dev/cpuctl0" .
 164 .Pp
 165 The command
 166 .Pp
 167 .Dq Li "cpucontrol -i 0x1 /dev/cpuctl1"
 168 .Pp
 169 will retrieve the CPUID level 0x1 from CPU 1.
 170 .Pp
 171 To perform firmware updates on CPU 0 from images located at
 172 .Pa /usr/local/share/cpuctl
 173 use the following command:
 174 .Pp
 175 .Dq Li "cpucontrol -nd /usr/local/share/cpuctl -u /dev/cpuctl0"
 176 .Sh SEE ALSO
 177 .Xr cpuctl 4
 178 .Sh HISTORY
 179 The
 180 .Nm
 181 utility first appeared in
 182 .Fx 7.2 .
 183 .Sh AUTHORS
 184 The
 185 .Nm
 186 utility and this manual page was written by
 187 .An Stanislav Sedov Aq Mt stas@FreeBSD.org .