1.\" $NetBSD: cpuctl.8,v 1.18 2018/01/14 00:45:54 mrg Exp $ 2.\" 3.\" Copyright (c) 2007, 2008, 2012, 2015 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" 6.\" This code is derived from software contributed to The NetBSD Foundation 7.\" by Andrew Doran. 8.\" 9.\" Redistribution and use in source and binary forms, with or without 10.\" modification, are permitted provided that the following conditions 11.\" are met: 12.\" 1. Redistributions of source code must retain the above copyright 13.\" notice, this list of conditions and the following disclaimer. 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in the 16.\" documentation and/or other materials provided with the distribution. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 21.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28.\" POSSIBILITY OF SUCH DAMAGE. 29.\" 30.Dd January 13, 2018 31.Dt CPUCTL 8 32.Os 33.Sh NAME 34.Nm cpuctl 35.Nd program to control CPUs 36.Sh SYNOPSIS 37.Nm cpuctl 38.Op Fl v 39.Ar command 40.Op Ar arguments 41.Sh DESCRIPTION 42The 43.Nm 44command can be used to control and inspect the state of CPUs in the system. 45.Pp 46The first argument, 47.Ar command , 48specifies the action to take. 49Valid commands are: 50.Bl -tag -width offline 51.It identify Ar cpu Op Ar cpu ... 52Output information on the specified CPU's features and capabilities. 53Not available on all architectures. 54.It list 55For each CPU in the system, display the current state and time of the last 56state change. 57.It offline Ar cpu Op Ar cpu ... 58Set the specified CPUs off line. 59.Pp 60Unbound LWPs (lightweight processes) will not be executed on the CPUs 61while it is off line. 62Bound LWPs will continue to be executed on the CPUs, and device interrupts 63routed to the CPUs will continue to be handled. 64A future release of the system may allow device interrupts to be re-routed 65away from individual CPUs. 66.Pp 67At least one CPU in the system must remain on line. 68.It online Ar cpu Op Ar cpu ... 69Set the specified CPUs on line, making it available to run unbound LWPs. 70.It ucode Xo 71.Op Ar cpu 72.Op Ar file 73.Xc 74This applies the microcode patch to CPUs. 75If 76.Ar cpu 77is not specified or \-1, all CPUs are updated. 78If 79.Ar cpu 80is \-2, the current CPUs are updated. 81The default filename is used if no filename is specified. 82The 83.Cm identify 84command prints the installed version on the specified CPUs. 85On success the 86.Cm identify 87command show different ucode versions before and after this command. 88The ucode updates are found in the default firmware path found in 89sysctl hw.firmware.path. 90.It intr Ar cpu Op Ar cpu ... 91Enable interrupts for the specified CPUs if supported. 92.It nointr Ar cpu Op Ar cpu ... 93Disable interrupts for the specified CPUs if supported. 94.El 95.Pp 96Valid flags are: 97.Bl -tag -width indent 98.It Fl v 99Be more verbose. 100.El 101.Sh FILES 102.Bl -tag -width /dev/cpuctl -compact 103.It Pa /dev/cpuctl 104control device 105.It Pa /libdata/firmware/x86/amd/ 106The directory to install the microcode file for AMD CPUs into. 107The default filename is 108.Pa microcode_amd.bin 109for CPU families 0x10 to 0x14. 110The default filename is 111.Pa microcode_amd_famXXh.bin 112where 113.Dv XX 114is the CPU family starting with 15 (hex). 115Get it from 116.Lk http://www.amd64.org/microcode.html 117.El 118.Sh EXAMPLES 119Run 120.Dl cpuctl identify 0 121and you should see something like this: 122.Bd -literal -offset indent 123cpu0: UCode version: 0x1000080 124.Ed 125.Pp 126After applying the microcode patch with 127.Dl cpuctl ucode 0 128you can see with 129.Dl cpuctl identify 0 130that the patch got applied: 131.Bd -literal -offset indent 132cpu0: UCode version: 0x1000083 133.Ed 134.Sh SEE ALSO 135.Xr intrctl 8 , 136.Xr psrset 8 , 137.Xr schedctl 8 , 138.Xr sysctl 8 , 139.Xr firmload 9 140.Sh HISTORY 141The 142.Nm 143command first appeared in 144.Nx 5.0 . 145