xref: /freebsd-src/sys/contrib/device-tree/Bindings/power/supply/qcom,pm8916-bms-vm.yaml (revision 84943d6f38e936ac3b7a3947ca26eeb27a39f938)

# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/power/supply/qcom,pm8916-bms-vm.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Qualcomm Voltage Mode BMS

maintainers:
  - Nikita Travkin <nikita@trvn.ru>

description:
  Voltage Mode BMS is a hardware block found in some Qualcomm PMICs
  such as pm8916. This block performs battery voltage monitoring.

allOf:
  - $ref: power-supply.yaml#

properties:
  compatible:
    const: qcom,pm8916-bms-vm

  reg:
    maxItems: 1

  interrupts:
    items:
      - description: BMS FSM left S3 mode
      - description: BMS FSM entered S2 mode
      - description: OCV measured in S3 mode
      - description: OCV below threshold
      - description: FIFO update done
      - description: BMS FSM switched state

  interrupt-names:
    items:
      - const: cv_leave
      - const: cv_enter
      - const: ocv_good
      - const: ocv_thr
      - const: fifo
      - const: state_chg

  monitored-battery: true

  power-supplies: true

required:
  - compatible
  - reg
  - interrupts
  - interrupt-names
  - monitored-battery

additionalProperties: false

examples:
  - |
    #include <dt-bindings/interrupt-controller/irq.h>
    pmic {
      #address-cells = <1>;
      #size-cells = <0>;

      battery@4000 {
        compatible = "qcom,pm8916-bms-vm";
        reg = <0x4000>;
        interrupts = <0x0 0x40 0 IRQ_TYPE_EDGE_RISING>,
                     <0x0 0x40 1 IRQ_TYPE_EDGE_RISING>,
                     <0x0 0x40 2 IRQ_TYPE_EDGE_RISING>,
                     <0x0 0x40 3 IRQ_TYPE_EDGE_RISING>,
                     <0x0 0x40 4 IRQ_TYPE_EDGE_RISING>,
                     <0x0 0x40 5 IRQ_TYPE_EDGE_RISING>;
        interrupt-names = "cv_leave",
                          "cv_enter",
                          "ocv_good",
                          "ocv_thr",
                          "fifo",
                          "state_chg";

        monitored-battery = <&battery>;
        power-supplies = <&pm8916_charger>;
      };
    };