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