share/man/man4/jedec_ts.4

   1 .\"
   2 .\" Copyright (c) 2016 Andriy Gapon <avg@FreeBSD.org>
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  15 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  18 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  19 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd October 13, 2016
  28 .Dt JEDEC_TS 4
  29 .Os
  30 .Sh NAME
  31 .Nm jedec_ts
  32 .Nd driver for temperature sensors on memory modules
  33 .Sh SYNOPSIS
  34 .Bd -ragged -offset indent
  35 .Cd "device jedec_ts"
  36 .Cd "device smbus"
  37 .Ed
  38 .Pp
  39 Alternatively, to load the driver as a
  40 module at boot time, place the following line in
  41 .Xr loader.conf 5 :
  42 .Bd -literal -offset indent
  43 jedec_ts_load="YES"
  44 .Ed
  45 .Pp
  46 In
  47 .Pa /boot/device.hints :
  48 .Bd -literal -offset indent
  49 .Cd hint.jedec_ts.0.at="smbus0"
  50 .Cd hint.jedec_ts.0.addr="0x30"
  51 .Cd hint.jedec_ts.1.at="smbus0"
  52 .Cd hint.jedec_ts.1.addr="0x32"
  53 .Cd hint.jedec_ts.2.at="smbus0"
  54 .Cd hint.jedec_ts.2.addr="0x34"
  55 .Cd hint.jedec_ts.3.at="smbus0"
  56 .Cd hint.jedec_ts.3.addr="0x36"
  57 .Cd hint.jedec_ts.4.at="smbus0"
  58 .Cd hint.jedec_ts.4.addr="0x38"
  59 .Cd hint.jedec_ts.5.at="smbus0"
  60 .Cd hint.jedec_ts.5.addr="0x3A"
  61 .Cd hint.jedec_ts.6.at="smbus0"
  62 .Cd hint.jedec_ts.6.addr="0x3C"
  63 .Cd hint.jedec_ts.7.at="smbus0"
  64 .Cd hint.jedec_ts.7.addr="0x3E"
  65 .Ed
  66 .Sh DESCRIPTION
  67 The
  68 .Nm
  69 driver provides access to sensor data over the
  70 .Xr smbus 4 .
  71 The driver supports temperature sensors on memory modules that conform
  72 to JEDEC Standard 21-C, TSE2002 Specification.
  73 .Pp
  74 The access to
  75 .Nm
  76 data is made via the
  77 .Xr sysctl 8
  78 interface:
  79 .Bl -tag -width "dev.jedec_ts.%d.temp"
  80 .It Va dev.jedec_ts.%d.temp
  81 read-only value of the current temperature read by the sensor.
  82 .El
  83 .Pp
  84 On a system using
  85 .Xr device.hints 5 ,
  86 these values are configurable for
  87 .Nm :
  88 .Bl -tag -width "hint.jedec_ts.%d.addr"
  89 .It Va hint.jedec_ts.%d.at
  90 target
  91 .Xr smbus 4 .
  92 .It Va hint.jedec_ts.%d.addr
  93 .Nm
  94 SMBus address on the
  95 .Xr smbus 4 .
  96 .El
  97 .Pp
  98 .Nm
  99 temperature sensors can be wired to eight different addresses,
 100 allowing up to eight sensors on the same
 101 .Xr smbus 4 .
 102 .Pp
 103 If the sensors are on an I2C bus behind an
 104 .Xr iicbus 4
 105 controller, then the
 106 .Xr iicsmb 4
 107 bridge driver can be used to attach the
 108 .Xr smbus 4 .
 109 .Sh EXAMPLES
 110 .Ss Sensor read out for two memory modules:
 111 .Bd -literal
 112 dev.jedec_ts.0.temp: 40.2500C
 113 dev.jedec_ts.1.temp: 40.7500C
 114 .Ed
 115 .Sh SEE ALSO
 116 .Xr iicbus 4 ,
 117 .Xr iicsmb 4 ,
 118 .Xr smbus 4 ,
 119 .Xr sysctl 8
 120 .Sh HISTORY
 121 The
 122 .Nm
 123 driver first appeared in
 124 .Fx 12.0 .
 125 .Sh AUTHORS
 126 .An -nosplit
 127 The
 128 .Nm
 129 driver and this manual page were written by
 130 .An Andriy Gapon Aq Mt avg@FreeBSD.org .