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