summaryrefslogtreecommitdiffstats
path: root/Documentation/devicetree/bindings/iio/temperature/adi,ltc2983.yaml
blob: 0f79d9a01c490549ebd1a08e4e3e0aaa306070bc (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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/iio/temperature/adi,ltc2983.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Analog Devices LTC2983 Multi-sensor Temperature system

maintainers:
  - Nuno Sá <nuno.sa@analog.com>

description: |
  Analog Devices LTC2983 Multi-Sensor Digital Temperature Measurement System
  https://www.analog.com/media/en/technical-documentation/data-sheets/2983fc.pdf

properties:
  compatible:
    enum:
      - adi,ltc2983

  reg:
    maxItems: 1

  interrupts:
    maxItems: 1

  adi,mux-delay-config-us:
    description:
      The LTC2983 performs 2 or 3 internal conversion cycles per temperature
      result. Each conversion cycle is performed with different excitation and
      input multiplexer configurations. Prior to each conversion, these
      excitation circuits and input switch configurations are changed and an
      internal 1ms delay ensures settling prior to the conversion cycle in most
      cases. An extra delay can be configured using this property. The value is
      rounded to nearest 100us.
    maximum: 255

  adi,filter-notch-freq:
    description:
      Set's the default setting of the digital filter. The default is
      simultaneous 50/60Hz rejection.
      0 - 50/60Hz rejection
      1 - 60Hz rejection
      2 - 50Hz rejection
    $ref: /schemas/types.yaml#/definitions/uint32
    minimum: 0
    maximum: 2

  '#address-cells':
    const: 1

  '#size-cells':
    const: 0

patternProperties:
  "@([1-9]|1[0-9]|20)$":
    type: object

    properties:
      reg:
        description:
          The channel number. It can be connected to one of the 20 channels of
          the device.
        minimum: 1
        maximum: 20

      adi,sensor-type:
        description: Identifies the type of sensor connected to the device.
        $ref: /schemas/types.yaml#/definitions/uint32

    required:
      - reg
      - adi,sensor-type

  "^thermocouple@":
    type: object
    description:
      Represents a thermocouple sensor which is connected to one of the device
      channels.

    properties:
      adi,sensor-type:
        description: |
          1 - Type J Thermocouple
          2 - Type K Thermocouple
          3 - Type E Thermocouple
          4 - Type N Thermocouple
          5 - Type R Thermocouple
          6 - Type S Thermocouple
          7 - Type T Thermocouple
          8 - Type B Thermocouple
          9 - Custom Thermocouple
        $ref: /schemas/types.yaml#/definitions/uint32
        minimum: 1
        maximum: 9

      adi,single-ended:
        description:
          Boolean property which set's the thermocouple as single-ended.
        type: boolean

      adi,sensor-oc-current-microamp:
        description:
          This property set's the pulsed current value applied during
          open-circuit detect.
        enum: [10, 100, 500, 1000]

      adi,cold-junction-handle:
        description:
          Phandle which points to a sensor object responsible for measuring
          the thermocouple cold junction temperature.
        $ref: "/schemas/types.yaml#/definitions/phandle"

      adi,custom-thermocouple:
        description:
          This is a table, where each entry should be a pair of
          voltage(mv)-temperature(K). The entries must be given in nv and uK
          so that, the original values must be multiplied by 1000000. For
          more details look at table 69 and 70.
          Note should be signed, but dtc doesn't currently maintain the
          sign.
        $ref: /schemas/types.yaml#/definitions/uint64-matrix
        minItems: 3
        maxItems: 64
        items:
          minItems: 2
          maxItems: 2

  "^diode@":
    type: object
    description:
      Represents a diode sensor which is connected to one of the device
      channels.

    properties:
      adi,sensor-type:
        description: Identifies the sensor as a diode.
        $ref: /schemas/types.yaml#/definitions/uint32
        const: 28

      adi,single-ended:
        description: Boolean property which set's the diode as single-ended.
        type: boolean

      adi,three-conversion-cycles:
        description:
          Boolean property which set's three conversion cycles removing
          parasitic resistance effects between the LTC2983 and the diode.
        type: boolean

      adi,average-on:
        description:
          Boolean property which enables a running average of the diode
          temperature reading. This reduces the noise when the diode is used
          as a cold junction temperature element on an isothermal block
          where temperatures change slowly.
        type: boolean

      adi,excitation-current-microamp:
        description:
          This property controls the magnitude of the excitation current
          applied to the diode. Depending on the number of conversions
          cycles, this property will assume different predefined values on
          each cycle. Just set the value of the first cycle (1l).
        enum: [10, 20, 40, 80]

      adi,ideal-factor-value:
        description:
          This property sets the diode ideality factor. The real value must
          be multiplied by 1000000 to remove the fractional part. For more
          information look at table 20 of the datasheet.
        $ref: /schemas/types.yaml#/definitions/uint32

  "^rtd@":
    type: object
    description:
      Represents a rtd sensor which is connected to one of the device channels.

    properties:
      reg:
        minimum: 2
        maximum: 20

      adi,sensor-type:
        description: |
          10 - RTD PT-10
          11 - RTD PT-50
          12 - RTD PT-100
          13 - RTD PT-200
          14 - RTD PT-500
          15 - RTD PT-1000
          16 - RTD PT-1000 (0.00375)
          17 - RTD NI-120
          18 - RTD Custom
        $ref: /schemas/types.yaml#/definitions/uint32
        minimum: 10
        maximum: 18

      adi,rsense-handle:
        description:
          Phandle pointing to a rsense object associated with this RTD.
        $ref: "/schemas/types.yaml#/definitions/phandle"

      adi,number-of-wires:
        description:
          Identifies the number of wires used by the RTD. Setting this
          property to 5 means 4 wires with Kelvin Rsense.
        $ref: /schemas/types.yaml#/definitions/uint32
        enum: [2, 3, 4, 5]

      adi,rsense-share:
        description:
          Boolean property which enables Rsense sharing, where one sense
          resistor is used for multiple 2-, 3-, and/or 4-wire RTDs.
        type: boolean

      adi,current-rotate:
        description:
          Boolean property which enables excitation current rotation to
          automatically remove parasitic thermocouple effects. Note that
          this property is not allowed for 2- and 3-wire RTDs.
        type: boolean

      adi,excitation-current-microamp:
        description:
          This property controls the magnitude of the excitation current
          applied to the RTD.
        enum: [5, 10, 25, 50, 100, 250, 500, 1000]

      adi,rtd-curve:
        description:
          This property set the RTD curve used and the corresponding
          Callendar-VanDusen constants. Look at table 30 of the datasheet.
        $ref: /schemas/types.yaml#/definitions/uint32
        minimum: 0
        maximum: 3

      adi,custom-rtd:
        description:
          This is a table, where each entry should be a pair of
          resistance(ohm)-temperature(K). The entries added here are in uohm
          and uK. For more details values look at table 74 and 75.
        $ref: /schemas/types.yaml#/definitions/uint64-matrix
        items:
          minItems: 3
          maxItems: 64
          items:
            minItems: 2
            maxItems: 2

    required:
      - adi,rsense-handle

    dependencies:
      adi,current-rotate: [ "adi,rsense-share" ]

  "^thermistor@":
    type: object
    description:
      Represents a thermistor sensor which is connected to one of the device
      channels.

    properties:
      adi,sensor-type:
        description:
          19 - Thermistor 44004/44033 2.252kohm at 25°C
          20 - Thermistor 44005/44030 3kohm at 25°C
          21 - Thermistor 44007/44034 5kohm at 25°C
          22 - Thermistor 44006/44031 10kohm at 25°C
          23 - Thermistor 44008/44032 30kohm at 25°C
          24 - Thermistor YSI 400 2.252kohm at 25°C
          25 - Thermistor Spectrum 1003k 1kohm
          26 - Thermistor Custom Steinhart-Hart
          27 - Custom Thermistor
        $ref: /schemas/types.yaml#/definitions/uint32
        minimum: 19
        maximum: 27

      adi,rsense-handle:
        description:
          Phandle pointing to a rsense object associated with this
          thermistor.
        $ref: "/schemas/types.yaml#/definitions/phandle"

      adi,single-ended:
        description:
          Boolean property which set's the thermistor as single-ended.
        type: boolean

      adi,rsense-share:
        description:
          Boolean property which enables Rsense sharing, where one sense
          resistor is used for multiple thermistors. Note that this property
          is ignored if adi,single-ended is set.
        type: boolean

      adi,current-rotate:
        description:
          Boolean property which enables excitation current rotation to
          automatically remove parasitic thermocouple effects.
        type: boolean

      adi,excitation-current-nanoamp:
        description:
          This property controls the magnitude of the excitation current
          applied to the thermistor. Value 0 set's the sensor in auto-range
          mode.
        $ref: /schemas/types.yaml#/definitions/uint32
        enum: [0, 250, 500, 1000, 5000, 10000, 25000, 50000, 100000, 250000,
               500000, 1000000]

      adi,custom-thermistor:
        description:
          This is a table, where each entry should be a pair of
          resistance(ohm)-temperature(K). The entries added here are in uohm
          and uK only for custom thermistors. For more details look at table
          78 and 79.
        $ref: /schemas/types.yaml#/definitions/uint64-matrix
        minItems: 3
        maxItems: 64
        items:
          minItems: 2
          maxItems: 2

      adi,custom-steinhart:
        description:
          Steinhart-Hart coefficients are also supported and can
          be programmed into the device memory using this property. For
          Steinhart sensors the coefficients are given in the raw
          format. Look at table 82 for more information.
        $ref: /schemas/types.yaml#/definitions/uint32-array
        items:
          minItems: 6
          maxItems: 6

    required:
      - adi,rsense-handle

    dependencies:
      adi,current-rotate: [ "adi,rsense-share" ]

  "^adc@":
    type: object
    description: Represents a channel which is being used as a direct adc.

    properties:
      adi,sensor-type:
        description: Identifies the sensor as a direct adc.
        $ref: /schemas/types.yaml#/definitions/uint32
        const: 30

      adi,single-ended:
        description: Boolean property which set's the adc as single-ended.
        type: boolean

  "^rsense@":
    type: object
    description:
      Represents a rsense which is connected to one of the device channels.
      Rsense are used by thermistors and RTD's.

    properties:
      reg:
        minimum: 2
        maximum: 20

      adi,sensor-type:
        description: Identifies the sensor as a rsense.
        $ref: /schemas/types.yaml#/definitions/uint32
        const: 29

      adi,rsense-val-milli-ohms:
        description:
          Sets the value of the sense resistor. Look at table 20 of the
          datasheet for information.

    required:
      - adi,rsense-val-milli-ohms

required:
  - compatible
  - reg
  - interrupts

additionalProperties: false

examples:
  - |
    #include <dt-bindings/interrupt-controller/irq.h>
    spi {
        #address-cells = <1>;
        #size-cells = <0>;

        sensor_ltc2983: ltc2983@0 {
                compatible = "adi,ltc2983";
                reg = <0>;

                #address-cells = <1>;
                #size-cells = <0>;

                interrupts = <20 IRQ_TYPE_EDGE_RISING>;
                interrupt-parent = <&gpio>;

                thermocouple@18 {
                        reg = <18>;
                        adi,sensor-type = <8>; //Type B
                        adi,sensor-oc-current-microamp = <10>;
                        adi,cold-junction-handle = <&diode5>;
                };

                diode5: diode@5 {
                        reg = <5>;
                        adi,sensor-type = <28>;
                };

                rsense2: rsense@2 {
                        reg = <2>;
                        adi,sensor-type = <29>;
                        adi,rsense-val-milli-ohms = <1200000>; //1.2Kohms
                };

                rtd@14 {
                        reg = <14>;
                        adi,sensor-type = <15>; //PT1000
                        /*2-wire, internal gnd, no current rotation*/
                        adi,number-of-wires = <2>;
                        adi,rsense-share;
                        adi,excitation-current-microamp = <500>;
                        adi,rsense-handle = <&rsense2>;
                };

                adc@10 {
                        reg = <10>;
                        adi,sensor-type = <30>;
                        adi,single-ended;
                };

                thermistor@12 {
                        reg = <12>;
                        adi,sensor-type = <26>; //Steinhart
                        adi,rsense-handle = <&rsense2>;
                        adi,custom-steinhart = <0x00F371EC 0x12345678
                                        0x2C0F8733 0x10018C66 0xA0FEACCD
                                        0x90021D99>; //6 entries
                };

                thermocouple@20 {
                        reg = <20>;
                        adi,sensor-type = <9>; //custom thermocouple
                        adi,single-ended;
                        adi,custom-thermocouple = /bits/ 64
                                 <(-50220000) 0>,
                                 <(-30200000) 99100000>,
                                 <(-5300000) 135400000>,
                                 <0 273150000>,
                                 <40200000 361200000>,
                                 <55300000 522100000>,
                                 <88300000 720300000>,
                                 <132200000 811200000>,
                                 <188700000 922500000>,
                                 <460400000 1000000000>; //10 pairs
               };

        };
    };
...