xref: /netbsd-src/usr.sbin/cpuctl/cpuctl.8 (revision 7788a0781fe6ff2cce37368b4578a7ade0850cb1)
1.\"	$NetBSD: cpuctl.8,v 1.9 2012/03/15 22:35:03 njoly 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 January 13, 2012
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.Ar command
39.Op Ar arguments
40.Sh DESCRIPTION
41The
42.Nm
43command can be used to control and inspect the state of CPUs in the system.
44.Pp
45The first argument,
46.Ar command ,
47specifies the action to take.
48Valid commands are:
49.Bl -tag -width XofflineXcpunoX
50.It identify Ar cpu
51Output information on the specified CPU's features and capabilities.
52Not available on all architectures.
53.It list
54For each CPU in the system, display the current state and time of the last
55state change.
56.It offline Ar cpuno
57Set the specified CPU off line.
58.Pp
59Unbound LWPs (lightweight processes) will not be executed on the CPU
60while it is off line.
61Bound LWPs will continue to be executed on the CPU, and device interrupts
62routed to the CPU will continue to be handled.
63A future release of the system may allow device interrupts to be re-routed
64away from individual CPUs.
65.Pp
66At least one CPU in the system must remain on line.
67.It online Ar cpuno
68Set the specified CPU on line, making it available to run unbound LWPs.
69.It ucode Op Ar file
70This applies the microcode patch on all CPUs.
71The default filename is used if no filename is specified.
72The
73.Cm identify
74command prints the installed version on that CPU.
75On success the
76.Cm identify
77command show different ucode versions before and after this command.
78.El
79.Sh FILES
80.Bl -tag -width /dev/cpuctl -compact
81.It Pa /dev/cpuctl
82control device
83.It Pa /libdata/firmware/x86/amd/
84The directory to install the microcode file for AMD CPUs into.
85The default filename is
86.Pa microcode_amd.bin
87for CPU families 0x10 to 0x14.
88The default filename is
89.Pa microcode_amd_famXXh.bin
90where
91.Dv XX
92is the CPU family starting with 15 (hex).
93Get it from
94.Lk http://www.amd64.org/support/microcode.html
95.El
96.Sh EXAMPLES
97Run
98.Dl cpuctl identify 0
99and you should see something like this:
100.Bd -literal -offset indent
101cpu0: UCode version: 0x1000080
102.Ed
103.Pp
104After applying the microcode patch with
105.Dl cpuctl ucode
106you can see with
107.Dl cpuctl identify 0
108that the patch got applied:
109.Bd -literal -offset indent
110cpu0: UCode version: 0x1000083
111.Ed
112.Sh SEE ALSO
113.Xr psrset 8 ,
114.Xr schedctl 8
115.Sh HISTORY
116The
117.Nm
118command first appeared in
119.Nx 5.0 .
120