Documentation/devicetree/bindings/hwmon/adi,adm1177.yaml

   1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
   2 %YAML 1.2
   3 ---
   4 $id: http://devicetree.org/schemas/hwmon/adi,adm1177.yaml#
   5 $schema: http://devicetree.org/meta-schemas/core.yaml#
   6
   7 title: Analog Devices ADM1177 Hot Swap Controller and Digital Power Monitor
   8
   9 maintainers:
  10   - Michael Hennerich <michael.hennerich@analog.com>
  11
  12 description: |
  13   Analog Devices ADM1177 Hot Swap Controller and Digital Power Monitor
  14   https://www.analog.com/media/en/technical-documentation/data-sheets/ADM1177.pdf
  15
  16 properties:
  17   compatible:
  18     enum:
  19       - adi,adm1177
  20
  21   reg:
  22     maxItems: 1
  23
  24   avcc-supply:
  25     description:
  26       Phandle to the Avcc power supply
  27
  28   shunt-resistor-micro-ohms:
  29     description:
  30       The value of curent sense resistor in microohms. If not provided,
  31       the current reading and overcurrent alert is disabled.
  32
  33   adi,shutdown-threshold-microamp:
  34     description:
  35       Specifies the current level at which an over current alert occurs.
  36       If not provided, the overcurrent alert is configured to max ADC range
  37       based on shunt-resistor-micro-ohms.
  38
  39   adi,vrange-high-enable:
  40     description:
  41       Specifies which internal voltage divider to be used. A 1 selects
  42       a 7:2 voltage divider while a 0 selects a 14:1 voltage divider.
  43     type: boolean
  44
  45 required:
  46   - compatible
  47   - reg
  48
  49 additionalProperties: false
  50
  51 examples:
  52   - |
  53     #include <dt-bindings/gpio/gpio.h>
  54     #include <dt-bindings/interrupt-controller/irq.h>
  55     i2c0 {
  56         #address-cells = <1>;
  57         #size-cells = <0>;
  58
  59         pwmon@5a {
  60                 compatible = "adi,adm1177";
  61                 reg = <0x5a>;
  62                 shunt-resistor-micro-ohms = <50000>; /* 50 mOhm */
  63                 adi,shutdown-threshold-microamp = <1059000>; /* 1.059 A */
  64                 adi,vrange-high-enable;
  65         };
  66     };
  67 ...