2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2006-2008 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 AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
33 #include <sys/param.h>
34 #include <sys/systm.h>
36 #include <sys/fcntl.h>
37 #include <sys/ioccom.h>
38 #include <sys/malloc.h>
39 #include <sys/module.h>
40 #include <sys/mutex.h>
43 #include <sys/queue.h>
44 #include <sys/sched.h>
45 #include <sys/kernel.h>
46 #include <sys/sysctl.h>
50 #include <sys/pmckern.h>
51 #include <sys/cpuctl.h>
54 #include <vm/vm_param.h>
57 #include <machine/cpufunc.h>
58 #include <machine/md_var.h>
59 #include <machine/specialreg.h>
60 #include <x86/ucode.h>
62 static d_open_t cpuctl_open;
63 static d_ioctl_t cpuctl_ioctl;
65 #define CPUCTL_VERSION 1
68 # define DPRINTF(format,...) printf(format, __VA_ARGS__);
73 #define UCODE_SIZE_MAX (4 * 1024 * 1024)
75 static int cpuctl_do_msr(int cpu, cpuctl_msr_args_t *data, u_long cmd,
77 static int cpuctl_do_cpuid(int cpu, cpuctl_cpuid_args_t *data,
79 static int cpuctl_do_cpuid_count(int cpu, cpuctl_cpuid_count_args_t *data,
81 static int cpuctl_do_eval_cpu_features(int cpu, struct thread *td);
82 static int cpuctl_do_update(int cpu, cpuctl_update_args_t *data,
84 static int update_intel(int cpu, cpuctl_update_args_t *args,
86 static int update_amd(int cpu, cpuctl_update_args_t *args, struct thread *td);
87 static int update_via(int cpu, cpuctl_update_args_t *args,
90 static struct cdev **cpuctl_devs;
91 static MALLOC_DEFINE(M_CPUCTL, "cpuctl", "CPUCTL buffer");
93 static struct cdevsw cpuctl_cdevsw = {
94 .d_version = D_VERSION,
95 .d_open = cpuctl_open,
96 .d_ioctl = cpuctl_ioctl,
101 * This function checks if specified cpu enabled or not.
107 return (pmc_cpu_is_disabled(cpu) == 0);
111 * Check if the current thread is bound to a specific cpu.
114 cpu_sched_is_bound(struct thread *td)
119 ret = sched_is_bound(td);
125 * Switch to target cpu to run.
128 set_cpu(int cpu, struct thread *td)
131 KASSERT(cpu >= 0 && cpu <= mp_maxid && cpu_enabled(cpu),
132 ("[cpuctl,%d]: bad cpu number %d", __LINE__, cpu));
136 KASSERT(td->td_oncpu == cpu,
137 ("[cpuctl,%d]: cannot bind to target cpu %d on cpu %d", __LINE__,
142 restore_cpu(int oldcpu, int is_bound, struct thread *td)
145 KASSERT(oldcpu >= 0 && oldcpu <= mp_maxid && cpu_enabled(oldcpu),
146 ("[cpuctl,%d]: bad cpu number %d", __LINE__, oldcpu));
151 sched_bind(td, oldcpu);
156 cpuctl_ioctl(struct cdev *dev, u_long cmd, caddr_t data,
157 int flags, struct thread *td)
162 if (cpu > mp_maxid || !cpu_enabled(cpu)) {
163 DPRINTF("[cpuctl,%d]: bad cpu number %d\n", __LINE__, cpu);
166 /* Require write flag for "write" requests. */
167 if ((cmd == CPUCTL_MSRCBIT || cmd == CPUCTL_MSRSBIT ||
168 cmd == CPUCTL_UPDATE || cmd == CPUCTL_WRMSR ||
169 cmd == CPUCTL_EVAL_CPU_FEATURES) &&
170 (flags & FWRITE) == 0)
174 ret = cpuctl_do_msr(cpu, (cpuctl_msr_args_t *)data, cmd, td);
179 ret = priv_check(td, PRIV_CPUCTL_WRMSR);
182 ret = cpuctl_do_msr(cpu, (cpuctl_msr_args_t *)data, cmd, td);
185 ret = cpuctl_do_cpuid(cpu, (cpuctl_cpuid_args_t *)data, td);
188 ret = priv_check(td, PRIV_CPUCTL_UPDATE);
191 ret = cpuctl_do_update(cpu, (cpuctl_update_args_t *)data, td);
193 case CPUCTL_CPUID_COUNT:
194 ret = cpuctl_do_cpuid_count(cpu,
195 (cpuctl_cpuid_count_args_t *)data, td);
197 case CPUCTL_EVAL_CPU_FEATURES:
198 ret = cpuctl_do_eval_cpu_features(cpu, td);
209 * Actually perform cpuid operation.
212 cpuctl_do_cpuid_count(int cpu, cpuctl_cpuid_count_args_t *data,
218 KASSERT(cpu >= 0 && cpu <= mp_maxid,
219 ("[cpuctl,%d]: bad cpu number %d", __LINE__, cpu));
221 /* Explicitly clear cpuid data to avoid returning stale info. */
222 bzero(data->data, sizeof(data->data));
223 DPRINTF("[cpuctl,%d]: retrieving cpuid lev %#0x type %#0x for %d cpu\n",
224 __LINE__, data->level, data->level_type, cpu);
229 oldcpu = td->td_oncpu;
230 is_bound = cpu_sched_is_bound(td);
232 cpuid_count(data->level, data->level_type, data->data);
233 restore_cpu(oldcpu, is_bound, td);
238 cpuctl_do_cpuid(int cpu, cpuctl_cpuid_args_t *data, struct thread *td)
240 cpuctl_cpuid_count_args_t cdata;
243 cdata.level = data->level;
244 /* Override the level type. */
245 cdata.level_type = 0;
246 error = cpuctl_do_cpuid_count(cpu, &cdata, td);
247 bcopy(cdata.data, data->data, sizeof(data->data)); /* Ignore error */
252 * Actually perform MSR operations.
255 cpuctl_do_msr(int cpu, cpuctl_msr_args_t *data, u_long cmd, struct thread *td)
262 KASSERT(cpu >= 0 && cpu <= mp_maxid,
263 ("[cpuctl,%d]: bad cpu number %d", __LINE__, cpu));
266 * Explicitly clear cpuid data to avoid returning stale
269 DPRINTF("[cpuctl,%d]: operating on MSR %#0x for %d cpu\n", __LINE__,
272 if ((cpu_feature & CPUID_MSR) == 0)
275 oldcpu = td->td_oncpu;
276 is_bound = cpu_sched_is_bound(td);
278 if (cmd == CPUCTL_RDMSR) {
280 ret = rdmsr_safe(data->msr, &data->data);
281 } else if (cmd == CPUCTL_WRMSR) {
282 ret = wrmsr_safe(data->msr, data->data);
283 } else if (cmd == CPUCTL_MSRSBIT) {
285 ret = rdmsr_safe(data->msr, ®);
287 ret = wrmsr_safe(data->msr, reg | data->data);
289 } else if (cmd == CPUCTL_MSRCBIT) {
291 ret = rdmsr_safe(data->msr, ®);
293 ret = wrmsr_safe(data->msr, reg & ~data->data);
296 panic("[cpuctl,%d]: unknown operation requested: %lu",
298 restore_cpu(oldcpu, is_bound, td);
303 * Actually perform microcode update.
306 cpuctl_do_update(int cpu, cpuctl_update_args_t *data, struct thread *td)
308 cpuctl_cpuid_args_t args = {
314 KASSERT(cpu >= 0 && cpu <= mp_maxid,
315 ("[cpuctl,%d]: bad cpu number %d", __LINE__, cpu));
316 DPRINTF("[cpuctl,%d]: XXX %d", __LINE__, cpu);
318 ret = cpuctl_do_cpuid(cpu, &args, td);
321 ((uint32_t *)vendor)[0] = args.data[1];
322 ((uint32_t *)vendor)[1] = args.data[3];
323 ((uint32_t *)vendor)[2] = args.data[2];
325 if (strncmp(vendor, INTEL_VENDOR_ID, sizeof(INTEL_VENDOR_ID)) == 0)
326 ret = update_intel(cpu, data, td);
327 else if(strncmp(vendor, AMD_VENDOR_ID, sizeof(AMD_VENDOR_ID)) == 0)
328 ret = update_amd(cpu, data, td);
329 else if(strncmp(vendor, CENTAUR_VENDOR_ID, sizeof(CENTAUR_VENDOR_ID))
331 ret = update_via(cpu, data, td);
337 struct ucode_update_data {
344 ucode_intel_load_rv(void *arg)
346 struct ucode_update_data *d;
349 if (PCPU_GET(cpuid) == d->cpu)
350 d->ret = ucode_intel_load(d->ptr, true, NULL, NULL);
354 update_intel(int cpu, cpuctl_update_args_t *args, struct thread *td)
356 struct ucode_update_data d;
358 int is_bound, oldcpu, ret;
360 if (args->size == 0 || args->data == NULL) {
361 DPRINTF("[cpuctl,%d]: zero-sized firmware image", __LINE__);
364 if (args->size > UCODE_SIZE_MAX) {
365 DPRINTF("[cpuctl,%d]: firmware image too large", __LINE__);
370 * 16 byte alignment required. Rely on the fact that
371 * malloc(9) always returns the pointer aligned at least on
372 * the size of the allocation.
374 ptr = malloc(args->size + 16, M_CPUCTL, M_WAITOK);
375 if (copyin(args->data, ptr, args->size) != 0) {
376 DPRINTF("[cpuctl,%d]: copyin %p->%p of %zd bytes failed",
377 __LINE__, args->data, ptr, args->size);
381 oldcpu = td->td_oncpu;
382 is_bound = cpu_sched_is_bound(td);
386 smp_rendezvous(NULL, ucode_intel_load_rv, NULL, &d);
387 restore_cpu(oldcpu, is_bound, td);
391 * Replace any existing update. This ensures that the new update
392 * will be reloaded automatically during ACPI resume.
395 ptr = ucode_update(ptr);
403 * NB: MSR 0xc0010020, MSR_K8_UCODE_UPDATE, is not documented by AMD.
404 * Coreboot, illumos and Linux source code was used to understand
408 amd_ucode_wrmsr(void *ucode_ptr)
412 wrmsr_safe(MSR_K8_UCODE_UPDATE, (uintptr_t)ucode_ptr);
417 update_amd(int cpu, cpuctl_update_args_t *args, struct thread *td)
422 if (args->size == 0 || args->data == NULL) {
423 DPRINTF("[cpuctl,%d]: zero-sized firmware image", __LINE__);
426 if (args->size > UCODE_SIZE_MAX) {
427 DPRINTF("[cpuctl,%d]: firmware image too large", __LINE__);
432 * 16 byte alignment required. Rely on the fact that
433 * malloc(9) always returns the pointer aligned at least on
434 * the size of the allocation.
436 ptr = malloc(args->size + 16, M_CPUCTL, M_ZERO | M_WAITOK);
437 if (copyin(args->data, ptr, args->size) != 0) {
438 DPRINTF("[cpuctl,%d]: copyin %p->%p of %zd bytes failed",
439 __LINE__, args->data, ptr, args->size);
443 smp_rendezvous(NULL, amd_ucode_wrmsr, NULL, ptr);
451 update_via(int cpu, cpuctl_update_args_t *args, struct thread *td)
454 uint64_t rev0, rev1, res;
460 if (args->size == 0 || args->data == NULL) {
461 DPRINTF("[cpuctl,%d]: zero-sized firmware image", __LINE__);
464 if (args->size > UCODE_SIZE_MAX) {
465 DPRINTF("[cpuctl,%d]: firmware image too large", __LINE__);
470 * 4 byte alignment required.
472 ptr = malloc(args->size, M_CPUCTL, M_WAITOK);
473 if (copyin(args->data, ptr, args->size) != 0) {
474 DPRINTF("[cpuctl,%d]: copyin %p->%p of %zd bytes failed",
475 __LINE__, args->data, ptr, args->size);
479 oldcpu = td->td_oncpu;
480 is_bound = cpu_sched_is_bound(td);
483 rdmsr_safe(MSR_BIOS_SIGN, &rev0); /* Get current microcode revision. */
488 wrmsr_safe(MSR_BIOS_UPDT_TRIG, (uintptr_t)(ptr));
492 * Result are in low byte of MSR FCR5:
493 * 0x00: No update has been attempted since RESET.
494 * 0x01: The last attempted update was successful.
495 * 0x02: The last attempted update was unsuccessful due to a bad
496 * environment. No update was loaded and any preexisting
497 * patches are still active.
498 * 0x03: The last attempted update was not applicable to this processor.
499 * No update was loaded and any preexisting patches are still
501 * 0x04: The last attempted update was not successful due to an invalid
502 * update data block. No update was loaded and any preexisting
503 * patches are still active
505 rdmsr_safe(0x1205, &res);
508 rdmsr_safe(MSR_BIOS_SIGN, &rev1); /* Get new microcode revision. */
509 restore_cpu(oldcpu, is_bound, td);
511 DPRINTF("[cpu,%d]: rev0=%x rev1=%x res=%x\n", __LINE__,
512 (unsigned)(rev0 >> 32), (unsigned)(rev1 >> 32), (unsigned)res);
524 cpuctl_do_eval_cpu_features(int cpu, struct thread *td)
529 KASSERT(cpu >= 0 && cpu <= mp_maxid,
530 ("[cpuctl,%d]: bad cpu number %d", __LINE__, cpu));
536 oldcpu = td->td_oncpu;
537 is_bound = cpu_sched_is_bound(td);
541 restore_cpu(oldcpu, is_bound, td);
542 hw_ibrs_recalculate(true);
543 hw_ssb_recalculate(true);
545 amd64_syscall_ret_flush_l1d_recalc();
546 pmap_allow_2m_x_ept_recalculate();
548 hw_mds_recalculate();
549 x86_taa_recalculate();
550 x86_rngds_mitg_recalculate(true);
556 cpuctl_open(struct cdev *dev, int flags, int fmt __unused, struct thread *td)
562 if (cpu > mp_maxid || !cpu_enabled(cpu)) {
563 DPRINTF("[cpuctl,%d]: incorrect cpu number %d\n", __LINE__,
568 ret = securelevel_gt(td->td_ucred, 0);
573 cpuctl_modevent(module_t mod __unused, int type, void *data __unused)
580 printf("cpuctl: access to MSR registers/cpuid info.\n");
581 cpuctl_devs = malloc(sizeof(*cpuctl_devs) * (mp_maxid + 1), M_CPUCTL,
584 if (cpu_enabled(cpu))
585 cpuctl_devs[cpu] = make_dev(&cpuctl_cdevsw, cpu,
586 UID_ROOT, GID_KMEM, 0640, "cpuctl%d", cpu);
590 if (cpuctl_devs[cpu] != NULL)
591 destroy_dev(cpuctl_devs[cpu]);
593 free(cpuctl_devs, M_CPUCTL);
603 DEV_MODULE(cpuctl, cpuctl_modevent, NULL);
604 MODULE_VERSION(cpuctl, CPUCTL_VERSION);