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   http://www.ti.com/lit/gpn/tmp513
  22   http://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     allOf:
  49       - $ref: /schemas/types.yaml#/definitions/uint32
  50     enum: [1, 2, 4, 8]
  51     default: 8
  52
  53   ti,bus-range-microvolt:
  54     description: |
  55       This is the operating range of the bus voltage in microvolt
  56     allOf:
  57       - $ref: /schemas/types.yaml#/definitions/uint32
  58     enum: [16000000, 32000000]
  59     default: 32000000
  60
  61   ti,nfactor:
  62     description: |
  63       Array of three(TMP513) or two(TMP512) n-Factor value for each remote
  64       temperature channel.
  65       See datasheet Table 11 for n-Factor range list and value interpretation.
  66     allOf:
  67       - $ref: /schemas/types.yaml#definitions/uint32-array
  68       - minItems: 2
  69         maxItems: 3
  70         items:
  71           default: 0x00
  72           minimum: 0x00
  73           maximum: 0xFF
  74
  75 required:
  76   - compatible
  77   - reg
  78
  79 additionalProperties: false
  80
  81 examples:
  82   - |
  83     i2c {
  84           #address-cells = <1>;
  85           #size-cells = <0>;
  86
  87           tmp513@5c {
  88               compatible = "ti,tmp513";
  89               reg = <0x5C>;
  90               shunt-resistor-micro-ohms = <330000>;
  91               ti,bus-range-microvolt = <32000000>;
  92               ti,pga-gain = <8>;
  93               ti,nfactor = <0x1 0xF3 0x00>;
  94           };
  95     };