Documentation/w1/slaves/w1_therm.rst

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