1 .\" Copyright (c) 2006, 2008 Stanislav Sedov <stas@FreeBSD.org>.
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
32 .Nd control utility for the
45 .Fl m Ar msr Ns = Ns Ar value
51 .Fl m Ar msr Ns &= Ns Ar mask
57 .Fl m Ar msr Ns |= Ns Ar mask
69 .Fl i Ar level,level_type
87 utility can be used to read and write arbitrary machine-specific
91 It can also be used to apply CPU firmware updates.
93 The following options are available:
94 .Bl -tag -width indent
96 Directory paths where to look for microcode images.
97 The option can be specified multiple times.
98 The paths are added in order of the options appearance on the command
99 line, default directories are appended after the user-supplied paths.
101 Do not look for the microcode images in the standard directories.
102 Currently standard directory to look for the microcode update files is
103 .Pa /usr/local/share/cpucontrol .
105 Show value of the specified MSR.
106 MSR register number should be given as a hexadecimal number.
107 The high word is printed first, then the low word is printed second.
108 .It Fl m Ar msr Ns = Ns Ar value
111 in the specified MSR register.
114 argument can be prefixed with ~ operator.
115 In this case the inverted value of argument will be stored in the register.
116 .It Fl m Ar msr Ns &= Ns Ar mask
117 Store the result of bitwise AND operation between
119 and the current MSR value in the MSR register.
122 argument can be prefixed with ~ operator.
123 In this case the inverted value of mask will be used.
124 .It Fl m Ar msr Ns |= Ns Ar mask
125 Store the result of bitwise OR operation between
127 and the current MSR value in the MSR register.
130 argument can be prefixed with ~ operator.
131 In this case the inverted value of mask will be used.
134 Level should be given as a hex number.
135 .It Fl i Ar level,level_type
137 Level and level_type should be given as hex numbers.
139 Apply CPU firmware updates.
142 utility will walk through the configured data directories
143 and apply all firmware updates available for this CPU.
145 Re-evaluate the kernel flags indicating the present CPU features.
146 This command is typically executed after a firmware update was applied
147 which changes information reported by the
154 command after the microcode update was applied to all CPUs in the system.
155 The kernel does not operate correctly if the features of processors are
159 Increase the verbosity level.
168 .Dq Li "cpucontrol -m 0x10 /dev/cpuctl0"
170 will read the contents of TSC MSR from CPU 0.
172 To set the CPU 0 TSC MSR register value to 0x1 issue
174 .Dq Li "cpucontrol -m 0x10=0x1 /dev/cpuctl0" .
176 The following command will clear the second bit of TSC register:
178 .Dq Li "cpucontrol -m 0x10&=~0x02 /dev/cpuctl0" .
180 The following command will set the forth and second bit of TSC register:
182 .Dq Li "cpucontrol -m 0x10|=0x0a /dev/cpuctl0" .
186 .Dq Li "cpucontrol -i 0x1 /dev/cpuctl1"
188 will retrieve the CPUID level 0x1 from CPU 1.
190 To perform firmware updates on CPU 0 from images located at
191 .Pa /usr/local/share/cpuctl
192 use the following command:
194 .Dq Li "cpucontrol -nd /usr/local/share/cpuctl -u /dev/cpuctl0"
200 utility first appeared in
205 utility and this manual page was written by
206 .An Stanislav Sedov Aq Mt stas@FreeBSD.org .