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   * GXCAS GC20MH01 temperature sensor.
  10
  11 Author: Evgeniy Polyakov <johnpol@2ka.mipt.ru>
  12
  13
  14 Description
  15 -----------
  16
  17 w1_therm provides basic temperature conversion for ds18*20, ds28ea00, GX20MH01
  18 devices.
  19
  20 Supported family codes:
  21
  22 ====================    ====
  23 W1_THERM_DS18S20        0x10
  24 W1_THERM_DS1822         0x22
  25 W1_THERM_DS18B20        0x28
  26 W1_THERM_DS1825         0x3B
  27 W1_THERM_DS28EA00       0x42
  28 ====================    ====
  29
  30 Support is provided through the sysfs entry ``w1_slave``. Each open and
  31 read sequence will initiate a temperature conversion, then provide two
  32 lines of ASCII output. The first line contains the nine hex bytes
  33 read along with a calculated crc value and YES or NO if it matched.
  34 If the crc matched the returned values are retained. The second line
  35 displays the retained values along with a temperature in millidegrees
  36 Centigrade after t=.
  37
  38 Alternatively, temperature can be read using ``temperature`` sysfs, it
  39 returns only the temperature in millidegrees Centigrade.
  40
  41 A bulk read of all devices on the bus could be done writing ``trigger``
  42 to ``therm_bulk_read`` entry at w1_bus_master level. This will
  43 send the convert command to all devices on the bus, and if parasite
  44 powered devices are detected on the bus (and strong pullup is enabled
  45 in the module), it will drive the line high during the longer conversion
  46 time required by parasited powered device on the line. Reading
  47 ``therm_bulk_read`` will return 0 if no bulk conversion pending,
  48 -1 if at least one sensor still in conversion, 1 if conversion is complete
  49 but at least one sensor value has not been read yet. Result temperature is
  50 then accessed by reading the ``temperature`` entry of each device, which
  51 may return empty if conversion is still in progress. Note that if a bulk
  52 read is sent but one sensor is not read immediately, the next access to
  53 ``temperature`` on this device will return the temperature measured at the
  54 time of issue of the bulk read command (not the current temperature).
  55
  56 A strong pullup will be applied during the conversion if required.
  57
  58 ``conv_time`` is used to get current conversion time (read), and
  59 adjust it (write). A temperature conversion time depends on the device type and
  60 it's current resolution. Default conversion time is set by the driver according
  61 to the device datasheet. A conversion time for many original device clones
  62 deviate from datasheet specs. There are three options: 1) manually set the
  63 correct conversion time by writing a value in milliseconds to ``conv_time``; 2)
  64 auto measure and set a conversion time by writing ``1`` to
  65 ``conv_time``; 3) use ``features`` to enable poll for conversion
  66 completion. Options 2, 3 can't be used in parasite power mode. To get back to
  67 the default conversion time write ``0`` to ``conv_time``.
  68
  69 Writing a resolution value (in bits) to ``w1_slave`` will change the
  70 precision of the sensor for the next readings. Allowed resolutions are defined by
  71 the sensor. Resolution is reset when the sensor gets power-cycled.
  72
  73 To store the current resolution in EEPROM, write ``0`` to ``w1_slave``.
  74 Since the EEPROM has a limited amount of writes (>50k), this command should be
  75 used wisely.
  76
  77 Alternatively, resolution can be read or written using the dedicated
  78 ``resolution`` entry on each device, if supported by the sensor.
  79
  80 Some non-genuine DS18B20 chips are fixed in 12-bit mode only, so the actual
  81 resolution is read back from the chip and verified.
  82
  83 Note: Changing the resolution reverts the conversion time to default.
  84
  85 The write-only sysfs entry ``eeprom_cmd`` is an alternative for EEPROM operations.
  86 Write ``save`` to save device RAM to EEPROM. Write ``restore`` to restore EEPROM
  87 data in device RAM.
  88
  89 ``ext_power`` entry allows checking the power state of each device. Reads
  90 ``0`` if the device is parasite powered, ``1`` if the device is externally powered.
  91
  92 Sysfs ``alarms`` allow read or write TH and TL (Temperature High an Low) alarms.
  93 Values shall be space separated and in the device range (typical -55 degC
  94 to 125 degC). Values are integer as they are store in a 8bit register in
  95 the device. Lowest value is automatically put to TL. Once set, alarms could
  96 be search at master level.
  97
  98 The module parameter strong_pullup can be set to 0 to disable the
  99 strong pullup, 1 to enable autodetection or 2 to force strong pullup.
 100 In case of autodetection, the driver will use the "READ POWER SUPPLY"
 101 command to check if there are pariste powered devices on the bus.
 102 If so, it will activate the master's strong pullup.
 103 In case the detection of parasite devices using this command fails
 104 (seems to be the case with some DS18S20) the strong pullup can
 105 be force-enabled.
 106
 107 If the strong pullup is enabled, the master's strong pullup will be
 108 driven when the conversion is taking place, provided the master driver
 109 does support the strong pullup (or it falls back to a pullup
 110 resistor).  The DS18b20 temperature sensor specification lists a
 111 maximum current draw of 1.5mA and that a 5k pullup resistor is not
 112 sufficient.  The strong pullup is designed to provide the additional
 113 current required.
 114
 115 The DS28EA00 provides an additional two pins for implementing a sequence
 116 detection algorithm.  This feature allows you to determine the physical
 117 location of the chip in the 1-wire bus without needing pre-existing
 118 knowledge of the bus ordering.  Support is provided through the sysfs
 119 ``w1_seq``. The file will contain a single line with an integer value
 120 representing the device index in the bus starting at 0.
 121
 122 ``features`` sysfs entry controls optional driver settings per device.
 123 Insufficient power in parasite mode, line noise and insufficient conversion
 124 time may lead to conversion failure. Original DS18B20 and some clones allow for
 125 detection of invalid conversion. Write bit mask ``1`` to ``features`` to enable
 126 checking the conversion success. If byte 6 of scratchpad memory is 0xC after
 127 conversion and temperature reads 85.00 (powerup value) or 127.94 (insufficient
 128 power), the driver returns a conversion error. Bit mask ``2`` enables poll for
 129 conversion completion (normal power only) by generating read cycles on the bus
 130 after conversion starts. In parasite power mode this feature is not available.
 131 Feature bit masks may be combined (OR). More details in
 132 Documentation/ABI/testing/sysfs-driver-w1_therm
 133
 134 GX20MH01 device shares family number 0x28 with DS18*20. The device is generally
 135 compatible with DS18B20. Added are lowest 2\ :sup:`-5`, 2\ :sup:`-6` temperature
 136 bits in Config register; R2 bit in Config register enabling 13 and 14 bit
 137 resolutions. The device is powered up in 14-bit resolution mode. The conversion
 138 times specified in the datasheet are too low and have to be increased. The
 139 device supports driver features ``1`` and ``2``.