Documentation/devicetree/bindings/iio/adc/richtek,rtq6056.yaml

   1 # SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
   2 %YAML 1.2
   3 ---
   4 $id: http://devicetree.org/schemas/iio/adc/richtek,rtq6056.yaml#
   5 $schema: http://devicetree.org/meta-schemas/core.yaml#
   6
   7 title: RTQ6056 Bi-Directional Current and Power Monitor with 16-bit ADC
   8
   9 maintainers:
  10   - ChiYuan Huang <cy_huang@richtek.com>
  11
  12 description: |
  13   The RTQ6056 is a high accuracy current-sense monitor with I2C and SMBus
  14   interface, and the device provides full information for system by reading
  15   out the loading current and power.
  16
  17   The device monitors both of the drops across sense resistor and the BUS
  18   voltage, converts into the current in amperes, and power in watts through
  19   internal analog-to-digital converter ADC. The programmable calibration,
  20   adjustable conversion time, and averaging function are also built in for
  21   more design flexibility.
  22
  23   Datasheet is available at
  24   https://www.richtek.com/assets/product_file/RTQ6056/DSQ6056-00.pdf
  25
  26 properties:
  27   compatible:
  28     const: richtek,rtq6056
  29
  30   reg:
  31     maxItems: 1
  32
  33   "#io-channel-cells":
  34     const: 1
  35
  36   shunt-resistor-micro-ohms:
  37     description: Shunt IN+/IN- sensing node resistor
  38
  39 required:
  40   - compatible
  41   - reg
  42   - "#io-channel-cells"
  43
  44 additionalProperties: false
  45
  46 examples:
  47   - |
  48     i2c {
  49       #address-cells = <1>;
  50       #size-cells = <0>;
  51       adc@40 {
  52         compatible = "richtek,rtq6056";
  53         reg = <0x40>;
  54         #io-channel-cells = <1>;
  55       };
  56     };