share/man/man4/kate.4

   1 .\"     $OpenBSD: kate.4,v 1.1 2008/03/27 01:54:44 cnst Exp $
   2 .\"
   3 .\" Copyright (c) 2008/2010 Constantine A. Murenin <cnst+dfly@bugmail.mojo.ru>
   4 .\"
   5 .\" Permission to use, copy, modify, and distribute this software for any
   6 .\" purpose with or without fee is hereby granted, provided that the above
   7 .\" copyright notice and this permission notice appear in all copies.
   8 .\"
   9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16 .\"
  17 .Dd February 12, 2010
  18 .Dt KATE 4
  19 .Os
  20 .Sh NAME
  21 .Nm kate
  22 .Nd AMD K8 temperature sensor
  23 .Sh SYNOPSIS
  24 To compile this driver into the kernel,
  25 place the following lines in your
  26 kernel configuration file:
  27 .Bd -ragged -offset indent
  28 .Cd "device pci"
  29 .Cd "device kate"
  30 .Ed
  31 .Pp
  32 Alternatively, to load the driver as a
  33 module at boot time, place the following line in
  34 .Xr loader.conf 5 :
  35 .Bd -literal -offset indent
  36 kate_load="YES"
  37 .Ed
  38 .Sh DESCRIPTION
  39 The
  40 .Nm
  41 driver provides support for the temperature sensors available in the
  42 AMD K8 family of processors.
  43 (Subsequent AMD families are supported by
  44 .Xr km 4 . )
  45 .Pp
  46 These sensors were officially introduced with
  47 Revision F Family 0Fh processors,
  48 and provide 1 degC accuracy.
  49 Precision was improved in Revision G chips,
  50 which provide two more bits for 0.25 degC steppings.
  51 Each core may have two temperature sensors, and
  52 there may be up to two cores per package.
  53 .Pp
  54 Multiprocessor systems would have one instance of
  55 .Nm
  56 per each chip.
  57 In each instance,
  58 .Va temp0
  59 and
  60 .Va temp1
  61 sensors
  62 correspond to the temperature sensors on the first core,
  63 whereas
  64 .Va temp2
  65 and
  66 .Va temp3
  67 correspond to the temperature sensors on the second core.
  68 As such, single core chips may have two sensors,
  69 and dual-core dual-processor systems may have as many as 8
  70 temperature sensors in total.
  71 .Pp
  72 Since many prior revisions of the chips appear to have
  73 valid readings for at least some temperature sensors
  74 in the same address space as the abovementioned revisions,
  75 the driver may also attach on such older revisions provided
  76 that it finds some sensor readings that appear valid.
  77 However, in such cases
  78 .Nm
  79 would not print the core revision information into the dmesg.
  80 .Pp
  81 Sensor values are made available through the
  82 .Dv HW_SENSORS
  83 .Xr sysctl 3
  84 interface,
  85 and can be monitored with the
  86 .Xr systat 1
  87 .Ar sensors
  88 display,
  89 .Xr sensorsd 8
  90 and
  91 .Xr sysctl 8
  92 .Ar hw.sensors .
  93 .Sh SEE ALSO
  94 .Xr systat 1 ,
  95 .Xr sysctl 3 ,
  96 .Xr intro 4 ,
  97 .Xr km 4 ,
  98 .Xr pci 4 ,
  99 .Xr sensorsd 8 ,
 100 .Xr sysctl 8
 101 .Rs
 102 .%T "BIOS and Kernel Developer's Guide for AMD NPT Family 0Fh Processors"
 103 .%D July 2007
 104 .%R Publication # 32559
 105 .%P pp. 21--23 and pp. 179--184
 106 .\" .%O http://www.amd.com/us-en/assets/content_type/white_papers_and_tech_docs/32559.pdf
 107 .Re
 108 .Rs
 109 .%T "Revision Guide for AMD NPT Family 0Fh Processors"
 110 .%D February 2008
 111 .%R Publication # 33610
 112 .\" .%O http://www.amd.com/us-en/assets/content_type/white_papers_and_tech_docs/33610.pdf
 113 .Re
 114 .Sh HISTORY
 115 The
 116 .Nm
 117 driver first appeared in
 118 .Ox 4.4
 119 and
 120 .Dx 2.5 .
 121 .Sh AUTHORS
 122 The
 123 .Nm
 124 driver was written for
 125 .Ox
 126 and
 127 .Dx
 128 by
 129 .An Constantine A. Murenin
 130 whilst at the University of Waterloo.