2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2008-2011 Stanislav Sedov <stas@FreeBSD.org>.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 * This utility provides userland access to the cpuctl(4) pseudo-device
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
47 #include <sys/queue.h>
48 #include <sys/param.h>
49 #include <sys/types.h>
52 #include <sys/ioctl.h>
53 #include <sys/cpuctl.h>
55 #include "cpucontrol.h"
60 int verbosity_level = 0;
62 #define DEFAULT_DATADIR "/usr/local/share/cpucontrol"
76 #define HIGH(val) (uint32_t)(((val) >> 32) & 0xffffffff)
77 #define LOW(val) (uint32_t)((val) & 0xffffffff)
81 SLIST_ENTRY(datadir) next;
83 static SLIST_HEAD(, datadir) datadirs = SLIST_HEAD_INITIALIZER(datadirs);
85 static struct ucode_handler {
87 ucode_update_t *update;
89 { intel_probe, intel_update },
90 { amd10h_probe, amd10h_update },
91 { amd_probe, amd_update },
92 { via_probe, via_update },
94 #define NHANDLERS (sizeof(handlers) / sizeof(*handlers))
96 static void usage(void);
97 static int do_cpuid(const char *cmdarg, const char *dev);
98 static int do_cpuid_count(const char *cmdarg, const char *dev);
99 static int do_msr(const char *cmdarg, const char *dev);
100 static int do_update(const char *dev);
101 static void datadir_add(const char *path);
108 name = getprogname();
111 fprintf(stderr, "Usage: %s [-vh] [-d datadir] [-m msr[=value] | "
112 "-i level | -i level,level_type | -e | -u] device\n", name);
117 do_cpuid(const char *cmdarg, const char *dev)
120 cpuctl_cpuid_args_t args;
124 assert(cmdarg != NULL);
127 level = strtoul(cmdarg, &endptr, 16);
128 if (*cmdarg == '\0' || *endptr != '\0') {
129 WARNX(0, "incorrect operand: %s", cmdarg);
135 * Fill ioctl argument structure.
138 fd = open(dev, O_RDONLY);
140 WARN(0, "error opening %s for reading", dev);
143 error = ioctl(fd, CPUCTL_CPUID, &args);
145 WARN(0, "ioctl(%s, CPUCTL_CPUID)", dev);
149 fprintf(stdout, "cpuid level 0x%x: 0x%.8x 0x%.8x 0x%.8x 0x%.8x\n",
150 level, args.data[0], args.data[1], args.data[2], args.data[3]);
156 do_cpuid_count(const char *cmdarg, const char *dev)
158 char *cmdarg1, *endptr, *endptr1;
159 unsigned int level, level_type;
160 cpuctl_cpuid_count_args_t args;
163 assert(cmdarg != NULL);
166 level = strtoul(cmdarg, &endptr, 16);
167 if (*cmdarg == '\0' || *endptr == '\0') {
168 WARNX(0, "incorrect or missing operand: %s", cmdarg);
172 /* Locate the comma... */
173 cmdarg1 = strstr(endptr, ",");
174 /* ... and skip past it */
176 level_type = strtoul(cmdarg1, &endptr1, 16);
177 if (*cmdarg1 == '\0' || *endptr1 != '\0') {
178 WARNX(0, "incorrect or missing operand: %s", cmdarg);
184 * Fill ioctl argument structure.
187 args.level_type = level_type;
188 fd = open(dev, O_RDONLY);
190 WARN(0, "error opening %s for reading", dev);
193 error = ioctl(fd, CPUCTL_CPUID_COUNT, &args);
195 WARN(0, "ioctl(%s, CPUCTL_CPUID_COUNT)", dev);
199 fprintf(stdout, "cpuid level 0x%x, level_type 0x%x: 0x%.8x 0x%.8x "
200 "0x%.8x 0x%.8x\n", level, level_type, args.data[0], args.data[1],
201 args.data[2], args.data[3]);
207 do_msr(const char *cmdarg, const char *dev)
210 cpuctl_msr_args_t args;
213 unsigned long command;
214 int do_invert = 0, op;
216 const char *command_name;
220 assert(cmdarg != NULL);
222 len = strlen(cmdarg);
224 WARNX(0, "MSR register expected");
230 * Parse command string.
232 msr = strtoul(cmdarg, &endptr, 16);
251 if (op != OP_READ) { /* Complex operation. */
260 data = strtoull(p, &endptr, 16);
261 if (*p == '\0' || *endptr != '\0') {
262 WARNX(0, "argument required: %s", cmdarg);
268 if (op == OP_INVAL) {
269 WARNX(0, "invalid operator: %s", cmdarg);
275 * Fill ioctl argument structure.
278 if ((do_invert != 0) ^ (op == OP_AND))
284 command = CPUCTL_RDMSR;
285 command_name = "RDMSR";
288 command = CPUCTL_WRMSR;
289 command_name = "WRMSR";
292 command = CPUCTL_MSRSBIT;
293 command_name = "MSRSBIT";
296 command = CPUCTL_MSRCBIT;
297 command_name = "MSRCBIT";
302 fd = open(dev, op == OP_READ ? O_RDONLY : O_WRONLY);
304 WARN(0, "error opening %s for %s", dev,
305 op == OP_READ ? "reading" : "writing");
308 error = ioctl(fd, command, &args);
310 WARN(0, "ioctl(%s, CPUCTL_%s (%lu))", dev, command_name, command);
315 fprintf(stdout, "MSR 0x%x: 0x%.8x 0x%.8x\n", msr,
316 HIGH(args.data), LOW(args.data));
322 do_eval_cpu_features(const char *dev)
328 fd = open(dev, O_RDWR);
330 WARN(0, "error opening %s for writing", dev);
333 error = ioctl(fd, CPUCTL_EVAL_CPU_FEATURES, NULL);
335 WARN(0, "ioctl(%s, CPUCTL_EVAL_CPU_FEATURES)", dev);
341 try_a_fw_image(const char *dev_path, int devfd, int fwdfd, const char *dpath,
342 const char *fname, struct ucode_handler *handler)
344 struct ucode_update_params parm;
353 fwfd = openat(fwdfd, fname, O_RDONLY);
355 WARN(0, "openat(%s, %s)", dpath, fname);
359 rc = asprintf(&fw_path, "%s/%s", dpath, fname);
361 WARNX(0, "out of memory");
366 rc = fstat(fwfd, &st);
368 WARN(0, "fstat(%s)", fw_path);
372 if (!S_ISREG(st.st_mode))
374 if (st.st_size <= 0) {
375 WARN(0, "%s: empty", fw_path);
379 fw_map = mmap(NULL, st.st_size, PROT_READ, MAP_PRIVATE, fwfd, 0);
380 if (fw_map == MAP_FAILED) {
381 WARN(0, "mmap(%s)", fw_path);
386 memset(&parm, 0, sizeof(parm));
388 parm.fwimage = fw_map;
389 parm.fwsize = st.st_size;
390 parm.dev_path = dev_path;
391 parm.fw_path = fw_path;
393 handler->update(&parm);
396 if (fw_map != MAP_FAILED)
397 munmap(fw_map, st.st_size);
405 do_update(const char *dev)
410 struct ucode_handler *handler;
413 struct dirent *direntry;
415 fd = open(dev, O_RDONLY);
417 WARN(0, "error opening %s for reading", dev);
422 * Find the appropriate handler for CPU.
424 for (i = 0; i < NHANDLERS; i++)
425 if (handlers[i].probe(fd) == 0)
428 handler = &handlers[i];
430 WARNX(0, "cannot find the appropriate handler for %s", dev);
436 fd = open(dev, O_RDWR);
438 WARN(0, "error opening %s for writing", dev);
443 * Process every image in specified data directories.
445 SLIST_FOREACH(dir, &datadirs, next) {
446 fwdfd = open(dir->path, O_RDONLY);
448 WARN(1, "skipping directory %s: not accessible", dir->path);
451 dirp = fdopendir(fwdfd);
453 WARNX(0, "out of memory");
459 while ((direntry = readdir(dirp)) != NULL) {
460 if (direntry->d_namlen == 0)
462 if (direntry->d_type == DT_DIR)
465 error = try_a_fw_image(dev, fd, fwdfd, dir->path,
466 direntry->d_name, handler);
473 error = closedir(dirp);
475 WARN(0, "closedir(%s)", dir->path);
482 * Add new data directory to the search list.
485 datadir_add(const char *path)
487 struct datadir *newdir;
489 newdir = (struct datadir *)malloc(sizeof(*newdir));
491 err(EX_OSERR, "cannot allocate memory");
493 SLIST_INSERT_HEAD(&datadirs, newdir, next);
497 main(int argc, char *argv[])
507 cmdarg = ""; /* To keep gcc3 happy. */
509 while ((c = getopt(argc, argv, "d:ehi:m:nuv")) != -1) {
547 if ((flags & FLAG_N) == 0)
548 datadir_add(DEFAULT_DATADIR);
550 c = flags & (FLAG_E | FLAG_I | FLAG_M | FLAG_U);
553 if (strstr(cmdarg, ",") != NULL)
554 error = do_cpuid_count(cmdarg, dev);
556 error = do_cpuid(cmdarg, dev);
559 error = do_msr(cmdarg, dev);
562 error = do_update(dev);
565 error = do_eval_cpu_features(dev);
568 usage(); /* Only one command can be selected. */
570 while ((elm = SLIST_FIRST(&datadirs)) != NULL) {
571 SLIST_REMOVE_HEAD(&datadirs, next);
574 return (error == 0 ? 0 : 1);