Documentation/hwmon/ntc

   1 Kernel driver ntc
   2 =================
   3
   4 Supported thermistors:
   5 * Murata NTC Thermistors "Chip" Type
   6   Prefix: 'ncp'
   7   NCPxxWB473: NCP15WB473, NCP18WB473, NCP21WB473, NCP03WB473
   8   NCPxxWL333: NCP15WL333
   9   Datasheet: Publicly available at Murata
  10
  11 Other NTC thermistors can be supported simply by adding compensation
  12 tables; e.g., NCP15WL333 support is added by the table ncpXXwl333.
  13
  14 Authors:
  15         MyungJoo Ham <myungjoo.ham@samsung.com>
  16
  17 Description
  18 -----------
  19
  20 The NTC thermistor is a simple thermistor that requires users to provide the
  21 resistance and lookup the corresponding compensation table to get the
  22 temperature input.
  23
  24 The NTC driver provides lookup tables with a linear approximation function
  25 and four circuit models with an option not to use any of the four models.
  26
  27 The four circuit models provided are:
  28
  29         $: resister, [TH]: the thermistor
  30
  31  1. connect = NTC_CONNECTED_POSITIVE, pullup_ohm > 0
  32
  33    [pullup_uV]
  34        |    |
  35       [TH]  $ (pullup_ohm)
  36        |    |
  37        +----+-----------------------[read_uV]
  38        |
  39        $ (pulldown_ohm)
  40        |
  41       --- (ground)
  42
  43  2. connect = NTC_CONNECTED_POSITIVE, pullup_ohm = 0 (not-connected)
  44
  45    [pullup_uV]
  46        |
  47       [TH]
  48        |
  49        +----------------------------[read_uV]
  50        |
  51        $ (pulldown_ohm)
  52        |
  53       --- (ground)
  54
  55  3. connect = NTC_CONNECTED_GROUND, pulldown_ohm > 0
  56
  57    [pullup_uV]
  58        |
  59        $ (pullup_ohm)
  60        |
  61        +----+-----------------------[read_uV]
  62        |    |
  63       [TH]  $ (pulldown_ohm)
  64        |    |
  65       -------- (ground)
  66
  67  4. connect = NTC_CONNECTED_GROUND, pulldown_ohm = 0 (not-connected)
  68
  69    [pullup_uV]
  70        |
  71        $ (pullup_ohm)
  72        |
  73        +----------------------------[read_uV]
  74        |
  75       [TH]
  76        |
  77       --- (ground)
  78
  79 When one of the four circuit models is used, read_uV, pullup_uV, pullup_ohm,
  80 pulldown_ohm, and connect should be provided. When none of the four models
  81 are suitable or the user can get the resistance directly, the user should
  82 provide read_ohm and _not_ provide the others.
  83
  84 If there is an error, the temperature value returned will be INT_MIN.
  85
  86 Sysfs Interface
  87 ---------------
  88 name            the mandatory global attribute, the thermistor name.
  89
  90 temp1_type      always 4 (thermistor)
  91                 RO
  92
  93 temp1_max       the highest temperature possible from the compensation table.
  94                 RO
  95
  96 temp1_min       the lowest temperature possible from the compensation table.
  97                 RO
  98
  99 temp1_input     measure the temperature and provide the measured value.
 100                 (reading this file initiates the reading procedure.)
 101                 RO
 102
 103 Note that each NTC thermistor has only _one_ thermistor; thus, only temp1 exists.