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