Documentation/devicetree/bindings/hwmon/ti,tmp513.yaml

   1 # SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
   2 %YAML 1.2
   3 ---
   4
   5 $id: http://devicetree.org/schemas/hwmon/ti,tmp513.yaml#
   6 $schema: http://devicetree.org/meta-schemas/core.yaml#
   7
   8 title: TMP513/512 system monitor sensor
   9
  10 maintainers:
  11   - Eric Tremblay <etremblay@distech-controls.com>
  12
  13 description: |
  14   The TMP512 (dual-channel) and TMP513 (triple-channel) are system monitors
  15   that include remote sensors, a local temperature sensor, and a high-side
  16   current shunt monitor. These system monitors have the capability of measuring
  17   remote temperatures, on-chip temperatures, and system voltage/power/current
  18   consumption.
  19
  20   Datasheets:
  21   https://www.ti.com/lit/gpn/tmp513
  22   https://www.ti.com/lit/gpn/tmp512
  23
  24
  25 properties:
  26   compatible:
  27     enum:
  28       - ti,tmp512
  29       - ti,tmp513
  30
  31   reg:
  32     maxItems: 1
  33
  34   shunt-resistor-micro-ohms:
  35     description: |
  36       If 0, the calibration process will be skiped and the current and power
  37       measurement engine will not work. Temperature and voltage measurement
  38       will continue to work. The shunt value also need to respect:
  39       rshunt <= pga-gain * 40 * 1000 * 1000.
  40       If not, it's not possible to compute a valid calibration value.
  41     default: 1000
  42
  43   ti,pga-gain:
  44     description: |
  45       The gain value for the PGA function. This is 8, 4, 2 or 1.
  46       The PGA gain affect the shunt voltage range.
  47       The range will be equal to: pga-gain * 40mV
  48     $ref: /schemas/types.yaml#/definitions/uint32
  49     enum: [1, 2, 4, 8]
  50     default: 8
  51
  52   ti,bus-range-microvolt:
  53     description: |
  54       This is the operating range of the bus voltage in microvolt
  55     $ref: /schemas/types.yaml#/definitions/uint32
  56     enum: [16000000, 32000000]
  57     default: 32000000
  58
  59   ti,nfactor:
  60     description: |
  61       Array of three(TMP513) or two(TMP512) n-Factor value for each remote
  62       temperature channel.
  63       See datasheet Table 11 for n-Factor range list and value interpretation.
  64     $ref: /schemas/types.yaml#/definitions/uint32-array
  65     minItems: 2
  66     maxItems: 3
  67     items:
  68       default: 0x00
  69       minimum: 0x00
  70       maximum: 0xFF
  71
  72 required:
  73   - compatible
  74   - reg
  75
  76 additionalProperties: false
  77
  78 examples:
  79   - |
  80     i2c {
  81           #address-cells = <1>;
  82           #size-cells = <0>;
  83
  84           tmp513@5c {
  85               compatible = "ti,tmp513";
  86               reg = <0x5C>;
  87               shunt-resistor-micro-ohms = <330000>;
  88               ti,bus-range-microvolt = <32000000>;
  89               ti,pga-gain = <8>;
  90               ti,nfactor = <0x1 0xF3 0x00>;
  91           };
  92     };