xref: /netbsd-src/usr.sbin/cpuctl/cpuctl.8 (revision 413d532bcc3f62d122e56d92e13ac64825a40baf)
1.\"	$NetBSD: cpuctl.8,v 1.12 2014/02/19 09:13:21 szptvlfn Exp $
2.\"
3.\" Copyright (c) 2007, 2008, 2012 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 December 23, 2013
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 XofflineXcpunoX
51.It identify 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 cpuno
58Set the specified CPU off line.
59.Pp
60Unbound LWPs (lightweight processes) will not be executed on the CPU
61while it is off line.
62Bound LWPs will continue to be executed on the CPU, and device interrupts
63routed to the CPU 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 cpuno
69Set the specified CPU on line, making it available to run unbound LWPs.
70.It ucode Op Ar file
71This applies the microcode patch on all CPUs.
72The default filename is used if no filename is specified.
73The
74.Cm identify
75command prints the installed version on that CPU.
76On success the
77.Cm identify
78command show different ucode versions before and after this command.
79.El
80.Pp
81Valid flags are:
82.Bl -tag -width indent
83.It Fl v
84Be more verbose.
85.El
86.Sh FILES
87.Bl -tag -width /dev/cpuctl -compact
88.It Pa /dev/cpuctl
89control device
90.It Pa /libdata/firmware/x86/amd/
91The directory to install the microcode file for AMD CPUs into.
92The default filename is
93.Pa microcode_amd.bin
94for CPU families 0x10 to 0x14.
95The default filename is
96.Pa microcode_amd_famXXh.bin
97where
98.Dv XX
99is the CPU family starting with 15 (hex).
100Get it from
101.Lk http://www.amd64.org/microcode.html
102.El
103.Sh EXAMPLES
104Run
105.Dl cpuctl identify 0
106and you should see something like this:
107.Bd -literal -offset indent
108cpu0: UCode version: 0x1000080
109.Ed
110.Pp
111After applying the microcode patch with
112.Dl cpuctl ucode
113you can see with
114.Dl cpuctl identify 0
115that the patch got applied:
116.Bd -literal -offset indent
117cpu0: UCode version: 0x1000083
118.Ed
119.Sh SEE ALSO
120.Xr psrset 8 ,
121.Xr schedctl 8
122.Sh HISTORY
123The
124.Nm
125command first appeared in
126.Nx 5.0 .
127