]> git.kernelconcepts.de Git - karo-tx-linux.git/blob - Documentation/w1/slaves/w1_therm
Merge remote-tracking branch 'kgdb/kgdb-next'
[karo-tx-linux.git] / Documentation / w1 / slaves / w1_therm
1 Kernel driver w1_therm
2 ====================
3
4 Supported chips:
5   * Maxim ds18*20 based temperature sensors.
6   * Maxim ds1825 based temperature sensors.
7
8 Author: Evgeniy Polyakov <johnpol@2ka.mipt.ru>
9
10
11 Description
12 -----------
13
14 w1_therm provides basic temperature conversion for ds18*20 devices, and the
15 ds28ea00 device.
16 supported family codes:
17 W1_THERM_DS18S20        0x10
18 W1_THERM_DS1822         0x22
19 W1_THERM_DS18B20        0x28
20 W1_THERM_DS1825         0x3B
21 W1_THERM_DS28EA00       0x42
22
23 Support is provided through the sysfs w1_slave file.  Each open and
24 read sequence will initiate a temperature conversion then provide two
25 lines of ASCII output.  The first line contains the nine hex bytes
26 read along with a calculated crc value and YES or NO if it matched.
27 If the crc matched the returned values are retained.  The second line
28 displays the retained values along with a temperature in millidegrees
29 Centigrade after t=.
30
31 Parasite powered devices are limited to one slave performing a
32 temperature conversion at a time.  If none of the devices are parasite
33 powered it would be possible to convert all the devices at the same
34 time and then go back to read individual sensors.  That isn't
35 currently supported.  The driver also doesn't support reduced
36 precision (which would also reduce the conversion time).
37
38 The module parameter strong_pullup can be set to 0 to disable the
39 strong pullup, 1 to enable autodetection or 2 to force strong pullup.
40 In case of autodetection, the driver will use the "READ POWER SUPPLY"
41 command to check if there are pariste powered devices on the bus.
42 If so, it will activate the master's strong pullup.
43 In case the detection of parasite devices using this command fails
44 (seems to be the case with some DS18S20) the strong pullup can
45 be force-enabled.
46 If the strong pullup is enabled, the master's strong pullup will be
47 driven when the conversion is taking place, provided the master driver
48 does support the strong pullup (or it falls back to a pullup
49 resistor).  The DS18b20 temperature sensor specification lists a
50 maximum current draw of 1.5mA and that a 5k pullup resistor is not
51 sufficient.  The strong pullup is designed to provide the additional
52 current required.
53
54 The DS28EA00 provides an additional two pins for implementing a sequence
55 detection algorithm.  This feature allows you to determine the physical
56 location of the chip in the 1-wire bus without needing pre-existing
57 knowledge of the bus ordering.  Support is provided through the sysfs
58 w1_seq file.  The file will contain a single line with an integer value
59 representing the device index in the bus starting at 0.