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>
53 #include <machine/cpufunc.h>
54 #include <machine/md_var.h>
55 #include <machine/specialreg.h>
57 static d_open_t cpuctl_open;
58 static d_ioctl_t cpuctl_ioctl;
60 #define CPUCTL_VERSION 1
63 # define DPRINTF(format,...) printf(format, __VA_ARGS__);
68 #define UCODE_SIZE_MAX (4 * 1024 * 1024)
70 static int cpuctl_do_msr(int cpu, cpuctl_msr_args_t *data, u_long cmd,
72 static int cpuctl_do_cpuid(int cpu, cpuctl_cpuid_args_t *data,
74 static int cpuctl_do_cpuid_count(int cpu, cpuctl_cpuid_count_args_t *data,
76 static int cpuctl_do_eval_cpu_features(int cpu, struct thread *td);
77 static int cpuctl_do_update(int cpu, cpuctl_update_args_t *data,
79 static int update_intel(int cpu, cpuctl_update_args_t *args,
81 static int update_amd(int cpu, cpuctl_update_args_t *args, struct thread *td);
82 static int update_via(int cpu, cpuctl_update_args_t *args,
85 static struct cdev **cpuctl_devs;
86 static MALLOC_DEFINE(M_CPUCTL, "cpuctl", "CPUCTL buffer");
88 static struct cdevsw cpuctl_cdevsw = {
89 .d_version = D_VERSION,
90 .d_open = cpuctl_open,
91 .d_ioctl = cpuctl_ioctl,
96 * This function checks if specified cpu enabled or not.
102 return (pmc_cpu_is_disabled(cpu) == 0);
106 * Check if the current thread is bound to a specific cpu.
109 cpu_sched_is_bound(struct thread *td)
114 ret = sched_is_bound(td);
120 * Switch to target cpu to run.
123 set_cpu(int cpu, struct thread *td)
126 KASSERT(cpu >= 0 && cpu <= mp_maxid && cpu_enabled(cpu),
127 ("[cpuctl,%d]: bad cpu number %d", __LINE__, cpu));
131 KASSERT(td->td_oncpu == cpu,
132 ("[cpuctl,%d]: cannot bind to target cpu %d on cpu %d", __LINE__,
137 restore_cpu(int oldcpu, int is_bound, struct thread *td)
140 KASSERT(oldcpu >= 0 && oldcpu <= mp_maxid && cpu_enabled(oldcpu),
141 ("[cpuctl,%d]: bad cpu number %d", __LINE__, oldcpu));
146 sched_bind(td, oldcpu);
151 cpuctl_ioctl(struct cdev *dev, u_long cmd, caddr_t data,
152 int flags, struct thread *td)
157 if (cpu > mp_maxid || !cpu_enabled(cpu)) {
158 DPRINTF("[cpuctl,%d]: bad cpu number %d\n", __LINE__, cpu);
161 /* Require write flag for "write" requests. */
162 if ((cmd == CPUCTL_MSRCBIT || cmd == CPUCTL_MSRSBIT ||
163 cmd == CPUCTL_UPDATE || cmd == CPUCTL_WRMSR ||
164 cmd == CPUCTL_EVAL_CPU_FEATURES) &&
165 (flags & FWRITE) == 0)
169 ret = cpuctl_do_msr(cpu, (cpuctl_msr_args_t *)data, cmd, td);
174 ret = priv_check(td, PRIV_CPUCTL_WRMSR);
177 ret = cpuctl_do_msr(cpu, (cpuctl_msr_args_t *)data, cmd, td);
180 ret = cpuctl_do_cpuid(cpu, (cpuctl_cpuid_args_t *)data, td);
183 ret = priv_check(td, PRIV_CPUCTL_UPDATE);
186 ret = cpuctl_do_update(cpu, (cpuctl_update_args_t *)data, td);
188 case CPUCTL_CPUID_COUNT:
189 ret = cpuctl_do_cpuid_count(cpu,
190 (cpuctl_cpuid_count_args_t *)data, td);
192 case CPUCTL_EVAL_CPU_FEATURES:
193 ret = cpuctl_do_eval_cpu_features(cpu, td);
204 * Actually perform cpuid operation.
207 cpuctl_do_cpuid_count(int cpu, cpuctl_cpuid_count_args_t *data,
213 KASSERT(cpu >= 0 && cpu <= mp_maxid,
214 ("[cpuctl,%d]: bad cpu number %d", __LINE__, cpu));
216 /* Explicitly clear cpuid data to avoid returning stale info. */
217 bzero(data->data, sizeof(data->data));
218 DPRINTF("[cpuctl,%d]: retrieving cpuid lev %#0x type %#0x for %d cpu\n",
219 __LINE__, data->level, data->level_type, cpu);
224 oldcpu = td->td_oncpu;
225 is_bound = cpu_sched_is_bound(td);
227 cpuid_count(data->level, data->level_type, data->data);
228 restore_cpu(oldcpu, is_bound, td);
233 cpuctl_do_cpuid(int cpu, cpuctl_cpuid_args_t *data, struct thread *td)
235 cpuctl_cpuid_count_args_t cdata;
238 cdata.level = data->level;
239 /* Override the level type. */
240 cdata.level_type = 0;
241 error = cpuctl_do_cpuid_count(cpu, &cdata, td);
242 bcopy(cdata.data, data->data, sizeof(data->data)); /* Ignore error */
247 * Actually perform MSR operations.
250 cpuctl_do_msr(int cpu, cpuctl_msr_args_t *data, u_long cmd, struct thread *td)
257 KASSERT(cpu >= 0 && cpu <= mp_maxid,
258 ("[cpuctl,%d]: bad cpu number %d", __LINE__, cpu));
261 * Explicitly clear cpuid data to avoid returning stale
264 DPRINTF("[cpuctl,%d]: operating on MSR %#0x for %d cpu\n", __LINE__,
267 if ((cpu_feature & CPUID_MSR) == 0)
270 oldcpu = td->td_oncpu;
271 is_bound = cpu_sched_is_bound(td);
273 if (cmd == CPUCTL_RDMSR) {
275 ret = rdmsr_safe(data->msr, &data->data);
276 } else if (cmd == CPUCTL_WRMSR) {
277 ret = wrmsr_safe(data->msr, data->data);
278 } else if (cmd == CPUCTL_MSRSBIT) {
280 ret = rdmsr_safe(data->msr, ®);
282 ret = wrmsr_safe(data->msr, reg | data->data);
284 } else if (cmd == CPUCTL_MSRCBIT) {
286 ret = rdmsr_safe(data->msr, ®);
288 ret = wrmsr_safe(data->msr, reg & ~data->data);
291 panic("[cpuctl,%d]: unknown operation requested: %lu",
293 restore_cpu(oldcpu, is_bound, td);
298 * Actually perform microcode update.
301 cpuctl_do_update(int cpu, cpuctl_update_args_t *data, struct thread *td)
303 cpuctl_cpuid_args_t args = {
309 KASSERT(cpu >= 0 && cpu <= mp_maxid,
310 ("[cpuctl,%d]: bad cpu number %d", __LINE__, cpu));
311 DPRINTF("[cpuctl,%d]: XXX %d", __LINE__, cpu);
313 ret = cpuctl_do_cpuid(cpu, &args, td);
316 ((uint32_t *)vendor)[0] = args.data[1];
317 ((uint32_t *)vendor)[1] = args.data[3];
318 ((uint32_t *)vendor)[2] = args.data[2];
320 if (strncmp(vendor, INTEL_VENDOR_ID, sizeof(INTEL_VENDOR_ID)) == 0)
321 ret = update_intel(cpu, data, td);
322 else if(strncmp(vendor, AMD_VENDOR_ID, sizeof(AMD_VENDOR_ID)) == 0)
323 ret = update_amd(cpu, data, td);
324 else if(strncmp(vendor, CENTAUR_VENDOR_ID, sizeof(CENTAUR_VENDOR_ID))
326 ret = update_via(cpu, data, td);
333 update_intel(int cpu, cpuctl_update_args_t *args, struct thread *td)
342 if (args->size == 0 || args->data == NULL) {
343 DPRINTF("[cpuctl,%d]: zero-sized firmware image", __LINE__);
346 if (args->size > UCODE_SIZE_MAX) {
347 DPRINTF("[cpuctl,%d]: firmware image too large", __LINE__);
352 * 16 byte alignment required. Rely on the fact that
353 * malloc(9) always returns the pointer aligned at least on
354 * the size of the allocation.
356 ptr = malloc(args->size + 16, M_CPUCTL, M_WAITOK);
357 if (copyin(args->data, ptr, args->size) != 0) {
358 DPRINTF("[cpuctl,%d]: copyin %p->%p of %zd bytes failed",
359 __LINE__, args->data, ptr, args->size);
363 oldcpu = td->td_oncpu;
364 is_bound = cpu_sched_is_bound(td);
367 rdmsr_safe(MSR_BIOS_SIGN, &rev0); /* Get current microcode revision. */
372 wrmsr_safe(MSR_BIOS_UPDT_TRIG, (uintptr_t)(ptr));
373 wrmsr_safe(MSR_BIOS_SIGN, 0);
376 * Serialize instruction flow.
380 rdmsr_safe(MSR_BIOS_SIGN, &rev1); /* Get new microcode revision. */
381 restore_cpu(oldcpu, is_bound, td);
392 * NB: MSR 0xc0010020, MSR_K8_UCODE_UPDATE, is not documented by AMD.
393 * Coreboot, illumos and Linux source code was used to understand
397 amd_ucode_wrmsr(void *ucode_ptr)
401 wrmsr_safe(MSR_K8_UCODE_UPDATE, (uintptr_t)ucode_ptr);
406 update_amd(int cpu, cpuctl_update_args_t *args, struct thread *td)
411 if (args->size == 0 || args->data == NULL) {
412 DPRINTF("[cpuctl,%d]: zero-sized firmware image", __LINE__);
415 if (args->size > UCODE_SIZE_MAX) {
416 DPRINTF("[cpuctl,%d]: firmware image too large", __LINE__);
421 * 16 byte alignment required. Rely on the fact that
422 * malloc(9) always returns the pointer aligned at least on
423 * the size of the allocation.
425 ptr = malloc(args->size + 16, M_CPUCTL, M_ZERO | M_WAITOK);
426 if (copyin(args->data, ptr, args->size) != 0) {
427 DPRINTF("[cpuctl,%d]: copyin %p->%p of %zd bytes failed",
428 __LINE__, args->data, ptr, args->size);
432 smp_rendezvous(NULL, amd_ucode_wrmsr, NULL, ptr);
440 update_via(int cpu, cpuctl_update_args_t *args, struct thread *td)
443 uint64_t rev0, rev1, res;
449 if (args->size == 0 || args->data == NULL) {
450 DPRINTF("[cpuctl,%d]: zero-sized firmware image", __LINE__);
453 if (args->size > UCODE_SIZE_MAX) {
454 DPRINTF("[cpuctl,%d]: firmware image too large", __LINE__);
459 * 4 byte alignment required.
461 ptr = malloc(args->size, M_CPUCTL, M_WAITOK);
462 if (copyin(args->data, ptr, args->size) != 0) {
463 DPRINTF("[cpuctl,%d]: copyin %p->%p of %zd bytes failed",
464 __LINE__, args->data, ptr, args->size);
468 oldcpu = td->td_oncpu;
469 is_bound = cpu_sched_is_bound(td);
472 rdmsr_safe(MSR_BIOS_SIGN, &rev0); /* Get current microcode revision. */
477 wrmsr_safe(MSR_BIOS_UPDT_TRIG, (uintptr_t)(ptr));
481 * Result are in low byte of MSR FCR5:
482 * 0x00: No update has been attempted since RESET.
483 * 0x01: The last attempted update was successful.
484 * 0x02: The last attempted update was unsuccessful due to a bad
485 * environment. No update was loaded and any preexisting
486 * patches are still active.
487 * 0x03: The last attempted update was not applicable to this processor.
488 * No update was loaded and any preexisting patches are still
490 * 0x04: The last attempted update was not successful due to an invalid
491 * update data block. No update was loaded and any preexisting
492 * patches are still active
494 rdmsr_safe(0x1205, &res);
497 rdmsr_safe(MSR_BIOS_SIGN, &rev1); /* Get new microcode revision. */
498 restore_cpu(oldcpu, is_bound, td);
500 DPRINTF("[cpu,%d]: rev0=%x rev1=%x res=%x\n", __LINE__,
501 (unsigned)(rev0 >> 32), (unsigned)(rev1 >> 32), (unsigned)res);
513 cpuctl_do_eval_cpu_features(int cpu, struct thread *td)
518 KASSERT(cpu >= 0 && cpu <= mp_maxid,
519 ("[cpuctl,%d]: bad cpu number %d", __LINE__, cpu));
525 oldcpu = td->td_oncpu;
526 is_bound = cpu_sched_is_bound(td);
530 hw_ibrs_recalculate();
531 restore_cpu(oldcpu, is_bound, td);
538 cpuctl_open(struct cdev *dev, int flags, int fmt __unused, struct thread *td)
544 if (cpu > mp_maxid || !cpu_enabled(cpu)) {
545 DPRINTF("[cpuctl,%d]: incorrect cpu number %d\n", __LINE__,
550 ret = securelevel_gt(td->td_ucred, 0);
555 cpuctl_modevent(module_t mod __unused, int type, void *data __unused)
562 printf("cpuctl: access to MSR registers/cpuid info.\n");
563 cpuctl_devs = malloc(sizeof(*cpuctl_devs) * (mp_maxid + 1), M_CPUCTL,
566 if (cpu_enabled(cpu))
567 cpuctl_devs[cpu] = make_dev(&cpuctl_cdevsw, cpu,
568 UID_ROOT, GID_KMEM, 0640, "cpuctl%d", cpu);
572 if (cpuctl_devs[cpu] != NULL)
573 destroy_dev(cpuctl_devs[cpu]);
575 free(cpuctl_devs, M_CPUCTL);
585 DEV_MODULE(cpuctl, cpuctl_modevent, NULL);
586 MODULE_VERSION(cpuctl, CPUCTL_VERSION);