share/man/man4/cpuctl.4

   1 .\" Copyright (c) 2006-2008 Stanislav Sedov <stas@FreeBSD.org>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD: release/10.0.0/share/man/man4/cpuctl.4 235317 2012-05-12 03:25:46Z gjb $
  26 .\"
  27 .Dd November 18, 2014
  28 .Dt CPUCTL 4
  29 .Os
  30 .Sh NAME
  31 .Nm cpuctl
  32 .Nd cpuctl pseudo device
  33 .Sh SYNOPSIS
  34 To compile this driver into the kernel,
  35 place the following lines in your kernel
  36 configuration file:
  37 .Bd -ragged -offset indent
  38 .Cd "device cpuctl"
  39 .Ed
  40 .Pp
  41 Alternatively, to load the driver as a module
  42 at boot time, place the following in
  43 .Xr loader.conf 5 :
  44 .Bd -literal -offset indent
  45 cpuctl_load="YES"
  46 .Ed
  47 .Sh DESCRIPTION
  48 The special device
  49 .Pa /dev/cpuctl
  50 presents interface to the system CPU.
  51 It provides functionality to retrieve
  52 CPUID information, read/write machine specific registers (MSR) and perform
  53 CPU firmware updates.
  54 .Pp
  55 For each CPU present in the system, the special device
  56 .Pa /dev/cpuctl%d
  57 with the appropriate index will be created.
  58 For multicore CPUs such a
  59 special device will be created for each core.
  60 .Pp
  61 Currently, only x86_64 processors are supported.
  62 .Sh IOCTL INTERFACE
  63 All of the supported operations are invoked using the
  64 .Xr ioctl 2
  65 system call.
  66 Currently, the following ioctls are defined:
  67 .Bl -tag -width CPUCTL_UPDATE
  68 .It Dv CPUCTL_RDMSR Fa cpuctl_msr_args_t *args
  69 .It Dv CPUCTL_WRMSR Fa cpuctl_msr_args_t *args
  70 Read/write CPU machine specific register.
  71 The
  72 .Vt cpuctl_msr_args_t
  73 structure is defined in
  74 .In sys/cpuctl.h
  75 as:
  76 .Bd -literal
  77 typedef struct {
  78         int             msr;    /* MSR to read */
  79         uint64_t        data;
  80 } cpuctl_msr_args_t;
  81 .Ed
  82 .It Dv CPUCTL_MSRSBIT Fa cpuctl_msr_args_t *args
  83 .It Dv CPUCTL_MSRCBIT Fa cpuctl_msr_args_t *args
  84 Set/clear MSR bits according to the mask given in the
  85 .Va data
  86 field.
  87 .It Dv CPUCTL_CPUID Fa cpuctl_cpuid_args_t *args
  88 Retrieve CPUID information.
  89 Arguments are supplied in
  90 the following struct:
  91 .Bd -literal
  92 typedef struct {
  93         int             level;  /* CPUID level */
  94         uint32_t        data[4];
  95 } cpuctl_cpuid_args_t;
  96 .Ed
  97 .Pp
  98 The
  99 .Va level
 100 field indicates the CPUID level to retrieve information for, while the
 101 .Va data
 102 field is used to store the received CPUID data.
 103 .It Dv CPUCTL_UPDATE cpuctl_update_args_t *args
 104 Update CPU firmware (microcode).
 105 The structure is defined in
 106 .In sys/cpuctl.h
 107 as:
 108 .Bd -literal
 109 typedef struct {
 110         void    *data;
 111         size_t  size;
 112 } cpuctl_update_args_t;
 113 .Ed
 114 .Pp
 115 The
 116 .Va data
 117 field should point to the firmware image of size
 118 .Va size .
 119 .El
 120 .Pp
 121 For additional information refer to
 122 .Pa cpuctl.h .
 123 .Sh FILES
 124 .Bl -tag -width /dev/cpuctl -compact
 125 .It Pa /dev/cpuctl
 126 .El
 127 .Sh ERRORS
 128 .Bl -tag -width Er
 129 .It Bq Er ENXIO
 130 The operation requested is not supported by the device (e.g., unsupported
 131 architecture or the CPU is disabled).
 132 .It Bq Er EINVAL
 133 Incorrect request was supplied, or microcode image is not correct.
 134 .It Bq Er ENOMEM
 135 No physical memory was available to complete the request.
 136 .It Bq Er EFAULT
 137 The firmware image address points outside the process address space.
 138 .El
 139 .Sh SEE ALSO
 140 .\".Xr hwpmc 4 ,
 141 .Xr cpucontrol 8
 142 .Sh HISTORY
 143 The
 144 .Nm
 145 driver first appeared in
 146 .Fx 7.2 .
 147 .Sh AUTHORS
 148 The
 149 .Nm
 150 module and this manual page were written by
 151 .An Stanislav Sedov Aq Mt stas@FreeBSD.org .
 152 .Sh BUGS
 153 Yes, probably, report if any.