summaryrefslogtreecommitdiff
path: root/static/freebsd/man4/lm75.4 3.html
blob: 3c1d4c1dd32ef5fd477a4bb177607c0ad44a805f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
<table class="head">
  <tr>
    <td class="head-ltitle">LM75(4)</td>
    <td class="head-vol">Device Drivers Manual</td>
    <td class="head-rtitle">LM75(4)</td>
  </tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">lm75</code> &#x2014; <span class="Nd">lm75 i2c
    digital temperature sensor driver</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp"><code class="Cd">device iic</code>
  <br/>
  <code class="Cd">device iicbus</code>
  <br/>
  <code class="Cd">device lm75</code></p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The <code class="Nm">lm75</code> driver provides access to sensor
    data and configuration over the <a class="Xr">iicbus(4)</a>.</p>
<p class="Pp">It provides an easy and simple way to check the functionality of
    an i2c bus as it provides read and write access to the
    <code class="Nm">lm75</code> configuration register.</p>
<p class="Pp">The access to <code class="Nm">lm75</code> data is made via the
    <a class="Xr">sysctl(8)</a> interface:</p>
<div class="Bd Pp Li">
<pre>dev.lm75.0.%desc: LM75 temperature sensor
dev.lm75.0.%driver: lm75
dev.lm75.0.%location: addr=0x49
dev.lm75.0.%pnpinfo: name=lm750 compat=national,lm75
dev.lm75.0.%parent: iicbus3
dev.lm75.0.temperature: 27.1C
dev.lm75.0.thyst: 75.0C
dev.lm75.0.tos: 80.0C
dev.lm75.0.faults: 1
dev.lm75.0.mode: comparator
dev.lm75.0.polarity: active-low
dev.lm75.0.shutdown: 0</pre>
</div>
<dl class="Bl-tag">
  <dt id="dev.lm75._d.temperature"><var class="Va">dev.lm75.%d.temperature</var></dt>
  <dd>Is the read-only value of the current temperature read by the sensor.</dd>
  <dt id="dev.lm75._d.thyst"><var class="Va">dev.lm75.%d.thyst</var></dt>
  <dd>Sets the hysteresis temperature. Once the temperature gets over the
      overtemperature shutdown value (tos) it needs to drop below the hysteresis
      temperature to disable the output (interrupt) pin again.</dd>
  <dt id="dev.lm75._d.tos"><var class="Va">dev.lm75.%d.tos</var></dt>
  <dd>Sets the overtemperature shutdown value. Once the temperature gets over
      this value the output pin will be enabled. The way the output (interrupt)
      pin works, depends on the mode configuration.</dd>
  <dt id="dev.lm75._d.faults"><var class="Va">dev.lm75.%d.faults</var></dt>
  <dd>Is the number of faults that must occur consecutively to activate the
      interrupt (output) pin. It can be set to 1, 2, 4, and 6.</dd>
  <dt id="dev.lm75._d.mode"><var class="Va">dev.lm75.%d.mode</var></dt>
  <dd>Sets the operation mode for the sensor interrupt pin. It can be set to
      'comparator' (default) or 'interrupt'.</dd>
  <dt id="dev.lm75._d.polarity"><var class="Va">dev.lm75.%d.polarity</var></dt>
  <dd>Sets the polarity of the sensor interrupt pin. It can be set to
      'active-low' (default) or 'active-high'. Please note that the output pin
      is an open-drain output and it needs a proper pull-up resistor to
    work.</dd>
  <dt id="dev.lm75._d.shutdown"><var class="Va">dev.lm75.%d.shutdown</var></dt>
  <dd>When set to '1' it shuts down the sensor. The temperature conversion stops
      but the sensor remains with its i2c bus active, i.e., it can be woken up
      by setting this option to '0' again.</dd>
</dl>
<p class="Pp">Please check the <code class="Nm">lm75</code> datasheet for more
    details.</p>
<p class="Pp">When used together with <a class="Xr">snmp_lm75(3)</a> it allows
    the monitoring of <code class="Nm">lm75</code> temperature data over
  SNMP.</p>
<p class="Pp">The <code class="Nm">lm75</code> driver supports both the low and
    the high resolution models.</p>
<p class="Pp">The low resolution model (lm75) provides a 9 bit output with the
    LSB representing 0.5C.</p>
<p class="Pp">The high resolution model (lm75a) provides an 11 bit output with
    the LSB representing 0.125C.</p>
<p class="Pp">The driver tries to auto-detect the <code class="Nm">lm75</code>
    model, but the detection of some <code class="Nm">lm75</code> clones may not
    work reliably.</p>
<p class="Pp">On a <a class="Xr">device.hints(5)</a> based system, such as
    <code class="Li">MIPS</code>, these values are configurable for
    <code class="Nm">lm75</code>:</p>
<dl class="Bl-tag">
  <dt id="hint.lm75._d.at"><var class="Va">hint.lm75.%d.at</var></dt>
  <dd>Is the <a class="Xr">iicbus(4)</a> you are attaching to.</dd>
  <dt id="hint.lm75._d.addr"><var class="Va">hint.lm75.%d.addr</var></dt>
  <dd>Is the <code class="Nm">lm75</code> i2c address on the
      <a class="Xr">iicbus(4)</a>.</dd>
</dl>
<p class="Pp">On a <a class="Xr">FDT(4)</a> based system, such as
    <code class="Li">ARM</code>, the DTS part for a <code class="Nm">lm75</code>
    device usually looks like:</p>
<div class="Bd Pp Li">
<pre>i2c {
	/* Properties describing the controller appear here. */
	...
	lm750@49 {
		compatible = &quot;national,lm75&quot;;
		reg = &lt;0x49&gt;;
	};
};</pre>
</div>
<p class="Pp">Where:</p>
<dl class="Bl-tag">
  <dt id="compatible"><var class="Va">compatible</var></dt>
  <dd>Should always be set to &quot;national,lm75&quot;.</dd>
  <dt id="reg"><var class="Va">reg</var></dt>
  <dd>Indicates which 7-bit i2c address the <code class="Nm">lm75</code> is
      wired at. <code class="Nm">lm75</code> temperature sensors can be wired to
      8 different addresses, allowing up to 8 sensors on the same
      <a class="Xr">iicbus(4)</a>.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
  ALSO</a></h1>
<p class="Pp"><a class="Xr">snmp_lm75(3)</a>, <a class="Xr">fdt(4)</a>,
    <a class="Xr">iic(4)</a>, <a class="Xr">iicbus(4)</a>,
    <a class="Xr">sysctl(8)</a></p>
</section>
<section class="Sh">
<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
<p class="Pp">The <code class="Nm">lm75</code> driver first appeared in
    <span class="Ux">FreeBSD 11.0</span>.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
<p class="Pp">The <code class="Nm">lm75</code> driver and this manual page were
    written by <span class="An">Luiz Otavio O Souza</span>
    &lt;<a class="Mt" href="mailto:loos@FreeBSD.org">loos@FreeBSD.org</a>&gt;.</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">December 26, 2017</td>
    <td class="foot-os">FreeBSD 15.0</td>
  </tr>
</table>