Commit 95027f5b authored by Cosmin Tanislav's avatar Cosmin Tanislav Committed by Jonathan Cameron

dt-bindings: iio: temperature: ltc2983: refine descriptions

Some descriptions are too verbose, while others are too succint.
Rewrite them all.
Signed-off-by: default avatarCosmin Tanislav <cosmin.tanislav@analog.com>
Reviewed-by: default avatarRob Herring <robh@kernel.org>
Link: https://lore.kernel.org/r/20221103130041.2153295-10-demonsingur@gmail.comSigned-off-by: default avatarJonathan Cameron <Jonathan.Cameron@huawei.com>
parent ee7e336c
...@@ -25,21 +25,16 @@ properties: ...@@ -25,21 +25,16 @@ properties:
maxItems: 1 maxItems: 1
adi,mux-delay-config-us: adi,mux-delay-config-us:
description: description: |
The LTC2983 performs 2 or 3 internal conversion cycles per temperature Extra delay prior to each conversion, in addition to the internal 1ms
result. Each conversion cycle is performed with different excitation and delay, for the multiplexer to switch input configurations and
input multiplexer configurations. Prior to each conversion, these excitation values.
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 maximum: 255
default: 0 default: 0
adi,filter-notch-freq: adi,filter-notch-freq:
description: description:
Set's the default setting of the digital filter. The default is Notch frequency of the digital filter.
simultaneous 50/60Hz rejection.
0 - 50/60Hz rejection 0 - 50/60Hz rejection
1 - 60Hz rejection 1 - 60Hz rejection
2 - 50Hz rejection 2 - 50Hz rejection
...@@ -57,17 +52,18 @@ properties: ...@@ -57,17 +52,18 @@ properties:
patternProperties: patternProperties:
"@([0-9a-f]+)$": "@([0-9a-f]+)$":
type: object type: object
description: Sensor.
properties: properties:
reg: reg:
description: description:
The channel number. It can be connected to one of the 20 channels of Channel number. Connects the sensor to the channel with this number
the device. of the device.
minimum: 1 minimum: 1
maximum: 20 maximum: 20
adi,sensor-type: adi,sensor-type:
description: Identifies the type of sensor connected to the device. description: Type of sensor connected to the device.
$ref: /schemas/types.yaml#/definitions/uint32 $ref: /schemas/types.yaml#/definitions/uint32
required: required:
...@@ -76,9 +72,7 @@ patternProperties: ...@@ -76,9 +72,7 @@ patternProperties:
"^thermocouple@": "^thermocouple@":
type: object type: object
description: description: Thermocouple sensor.
Represents a thermocouple sensor which is connected to one of the device
channels.
properties: properties:
adi,sensor-type: adi,sensor-type:
...@@ -97,31 +91,24 @@ patternProperties: ...@@ -97,31 +91,24 @@ patternProperties:
maximum: 9 maximum: 9
adi,single-ended: adi,single-ended:
description: description: Whether the sensor is single-ended.
Boolean property which set's the thermocouple as single-ended.
type: boolean type: boolean
adi,sensor-oc-current-microamp: adi,sensor-oc-current-microamp:
description: description: Pulsed current value applied during open-circuit detect.
This property set's the pulsed current value applied during
open-circuit detect.
enum: [10, 100, 500, 1000] enum: [10, 100, 500, 1000]
default: 10 default: 10
adi,cold-junction-handle: adi,cold-junction-handle:
description: description:
Phandle which points to a sensor object responsible for measuring Sensor responsible for measuring the thermocouple cold junction
the thermocouple cold junction temperature. temperature.
$ref: /schemas/types.yaml#/definitions/phandle $ref: /schemas/types.yaml#/definitions/phandle
adi,custom-thermocouple: adi,custom-thermocouple:
description: description:
This is a table, where each entry should be a pair of Used for digitizing custom thermocouples.
voltage(mv)-temperature(K). The entries must be given in nv and uK See Page 59 of the datasheet.
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 $ref: /schemas/types.yaml#/definitions/uint64-matrix
minItems: 3 minItems: 3
maxItems: 64 maxItems: 64
...@@ -141,55 +128,50 @@ patternProperties: ...@@ -141,55 +128,50 @@ patternProperties:
"^diode@": "^diode@":
type: object type: object
description: description: Diode sensor.
Represents a diode sensor which is connected to one of the device
channels.
properties: properties:
adi,sensor-type: adi,sensor-type:
description: Identifies the sensor as a diode. description: Sensor type for diodes.
$ref: /schemas/types.yaml#/definitions/uint32 $ref: /schemas/types.yaml#/definitions/uint32
const: 28 const: 28
adi,single-ended: adi,single-ended:
description: Boolean property which set's the diode as single-ended. description: Whether the sensor is single-ended.
type: boolean type: boolean
adi,three-conversion-cycles: adi,three-conversion-cycles:
description: description:
Boolean property which set's three conversion cycles removing Whether to use three conversion cycles to remove parasitic
parasitic resistance effects between the LTC2983 and the diode. resistance between the device and the diode.
type: boolean type: boolean
adi,average-on: adi,average-on:
description: description:
Boolean property which enables a running average of the diode Whether to use a running average of the diode temperature
temperature reading. This reduces the noise when the diode is used reading to reduce the noise when the diode is used as a cold
as a cold junction temperature element on an isothermal block junction temperature element on an isothermal block where
where temperatures change slowly. temperatures change slowly.
type: boolean type: boolean
adi,excitation-current-microamp: adi,excitation-current-microamp:
description: description:
This property controls the magnitude of the excitation current Magnitude of the 1l excitation current applied to the diode.
applied to the diode. Depending on the number of conversions 4l excitation current will be 4 times this value, and 8l
cycles, this property will assume different predefined values on excitation current will be 8 times value.
each cycle. Just set the value of the first cycle (1l).
enum: [10, 20, 40, 80] enum: [10, 20, 40, 80]
default: 10 default: 10
adi,ideal-factor-value: adi,ideal-factor-value:
description: description:
This property sets the diode ideality factor. The real value must Diode ideality factor.
be multiplied by 1000000 to remove the fractional part. For more Set this property to 1000000 times the real value.
information look at table 20 of the datasheet.
$ref: /schemas/types.yaml#/definitions/uint32 $ref: /schemas/types.yaml#/definitions/uint32
default: 0 default: 0
"^rtd@": "^rtd@":
type: object type: object
description: description: RTD sensor.
Represents a rtd sensor which is connected to one of the device channels.
properties: properties:
reg: reg:
...@@ -212,35 +194,35 @@ patternProperties: ...@@ -212,35 +194,35 @@ patternProperties:
maximum: 18 maximum: 18
adi,rsense-handle: adi,rsense-handle:
description: description: Associated sense resistor sensor.
Phandle pointing to a rsense object associated with this RTD.
$ref: /schemas/types.yaml#/definitions/phandle $ref: /schemas/types.yaml#/definitions/phandle
adi,number-of-wires: adi,number-of-wires:
description: description:
Identifies the number of wires used by the RTD. Setting this Number of wires used by the RTD.
property to 5 means 4 wires with Kelvin Rsense. 5 means 4 wires with Kelvin sense resistor.
$ref: /schemas/types.yaml#/definitions/uint32 $ref: /schemas/types.yaml#/definitions/uint32
enum: [2, 3, 4, 5] enum: [2, 3, 4, 5]
default: 2 default: 2
adi,rsense-share: adi,rsense-share:
description: description:
Boolean property which enables Rsense sharing, where one sense Whether to enable sense resistor sharing, where one sense
resistor is used for multiple 2-, 3-, and/or 4-wire RTDs. resistor is used by multiple sensors.
type: boolean type: boolean
adi,excitation-current-microamp: adi,excitation-current-microamp:
description: description: Excitation current applied to the RTD.
This property controls the magnitude of the excitation current
applied to the RTD.
enum: [5, 10, 25, 50, 100, 250, 500, 1000] enum: [5, 10, 25, 50, 100, 250, 500, 1000]
default: 5 default: 5
adi,rtd-curve: adi,rtd-curve:
description: description: |
This property set the RTD curve used and the corresponding RTD curve and the corresponding Callendar-VanDusen constants.
Callendar-VanDusen constants. Look at table 30 of the datasheet. 0 - European
1 - American
2 - Japanese
3 - ITS-90
$ref: /schemas/types.yaml#/definitions/uint32 $ref: /schemas/types.yaml#/definitions/uint32
minimum: 0 minimum: 0
maximum: 3 maximum: 3
...@@ -248,9 +230,8 @@ patternProperties: ...@@ -248,9 +230,8 @@ patternProperties:
adi,custom-rtd: adi,custom-rtd:
description: description:
This is a table, where each entry should be a pair of Used for digitizing custom RTDs.
resistance(ohm)-temperature(K). The entries added here are in uohm See Page 62 of the datasheet.
and uK. For more details values look at table 74 and 75.
$ref: /schemas/types.yaml#/definitions/uint64-matrix $ref: /schemas/types.yaml#/definitions/uint64-matrix
minItems: 3 minItems: 3
maxItems: 64 maxItems: 64
...@@ -288,9 +269,7 @@ patternProperties: ...@@ -288,9 +269,7 @@ patternProperties:
"^thermistor@": "^thermistor@":
type: object type: object
description: description: Thermistor sensor.
Represents a thermistor sensor which is connected to one of the device
channels.
properties: properties:
adi,sensor-type: adi,sensor-type:
...@@ -309,34 +288,29 @@ patternProperties: ...@@ -309,34 +288,29 @@ patternProperties:
maximum: 27 maximum: 27
adi,rsense-handle: adi,rsense-handle:
description: description: Associated sense resistor sensor.
Phandle pointing to a rsense object associated with this
thermistor.
$ref: /schemas/types.yaml#/definitions/phandle $ref: /schemas/types.yaml#/definitions/phandle
adi,single-ended: adi,single-ended:
description: description: Whether the sensor is single-ended.
Boolean property which set's the thermistor as single-ended.
type: boolean type: boolean
adi,rsense-share: adi,rsense-share:
description: description:
Boolean property which enables Rsense sharing, where one sense Whether to enable sense resistor sharing, where one sense
resistor is used for multiple thermistors. Note that this property resistor is used by multiple sensors.
is ignored if adi,single-ended is set.
type: boolean type: boolean
adi,current-rotate: adi,current-rotate:
description: description:
Boolean property which enables excitation current rotation to Whether to enable excitation current rotation to automatically
automatically remove parasitic thermocouple effects. remove parasitic thermocouple effects.
type: boolean type: boolean
adi,excitation-current-nanoamp: adi,excitation-current-nanoamp:
description: description:
This property controls the magnitude of the excitation current Excitation current applied to the thermistor.
applied to the thermistor. Value 0 set's the sensor in auto-range 0 sets the sensor in auto-range mode.
mode.
$ref: /schemas/types.yaml#/definitions/uint32 $ref: /schemas/types.yaml#/definitions/uint32
enum: [0, 250, 500, 1000, 5000, 10000, 25000, 50000, 100000, 250000, enum: [0, 250, 500, 1000, 5000, 10000, 25000, 50000, 100000, 250000,
500000, 1000000] 500000, 1000000]
...@@ -344,10 +318,8 @@ patternProperties: ...@@ -344,10 +318,8 @@ patternProperties:
adi,custom-thermistor: adi,custom-thermistor:
description: description:
This is a table, where each entry should be a pair of Used for digitizing custom thermistors.
resistance(ohm)-temperature(K). The entries added here are in uohm See Page 65 of the datasheet.
and uK only for custom thermistors. For more details look at table
78 and 79.
$ref: /schemas/types.yaml#/definitions/uint64-matrix $ref: /schemas/types.yaml#/definitions/uint64-matrix
minItems: 3 minItems: 3
maxItems: 64 maxItems: 64
...@@ -358,10 +330,9 @@ patternProperties: ...@@ -358,10 +330,9 @@ patternProperties:
adi,custom-steinhart: adi,custom-steinhart:
description: description:
Steinhart-Hart coefficients are also supported and can Steinhart-Hart coefficients in raw format, used for digitizing
be programmed into the device memory using this property. For custom thermistors.
Steinhart sensors the coefficients are given in the raw See Page 68 of the datasheet.
format. Look at table 82 for more information.
$ref: /schemas/types.yaml#/definitions/uint32-array $ref: /schemas/types.yaml#/definitions/uint32-array
minItems: 6 minItems: 6
maxItems: 6 maxItems: 6
...@@ -400,23 +371,21 @@ patternProperties: ...@@ -400,23 +371,21 @@ patternProperties:
"^adc@": "^adc@":
type: object type: object
description: Represents a channel which is being used as a direct adc. description: Direct ADC sensor.
properties: properties:
adi,sensor-type: adi,sensor-type:
description: Identifies the sensor as a direct adc. description: Sensor type for direct ADC sensors.
$ref: /schemas/types.yaml#/definitions/uint32 $ref: /schemas/types.yaml#/definitions/uint32
const: 30 const: 30
adi,single-ended: adi,single-ended:
description: Boolean property which set's the adc as single-ended. description: Whether the sensor is single-ended.
type: boolean type: boolean
"^rsense@": "^rsense@":
type: object type: object
description: description: Sense resistor sensor.
Represents a rsense which is connected to one of the device channels.
Rsense are used by thermistors and RTD's.
properties: properties:
reg: reg:
...@@ -424,14 +393,12 @@ patternProperties: ...@@ -424,14 +393,12 @@ patternProperties:
maximum: 20 maximum: 20
adi,sensor-type: adi,sensor-type:
description: Identifies the sensor as a rsense. description: Sensor type sense resistor sensors.
$ref: /schemas/types.yaml#/definitions/uint32 $ref: /schemas/types.yaml#/definitions/uint32
const: 29 const: 29
adi,rsense-val-milli-ohms: adi,rsense-val-milli-ohms:
description: description: Value of the sense resistor.
Sets the value of the sense resistor. Look at table 20 of the
datasheet for information.
required: required:
- adi,rsense-val-milli-ohms - adi,rsense-val-milli-ohms
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment