Commit e7c24317 authored by Sebastian Reichel's avatar Sebastian Reichel Committed by Sebastian Reichel
Browse files

dt-bindings: power: supply: bq24190: Convert to DT schema format



Convert the binding to DT schema format.

Signed-off-by: default avatarSebastian Reichel <sebastian.reichel@collabora.com>
Reviewed-by: default avatarRob Herring <robh@kernel.org>
parent 102d4a0b
Loading
Loading
Loading
Loading
+0 −61
Original line number Diff line number Diff line
TI BQ24190 Li-Ion Battery Charger

Required properties:
- compatible: contains one of the following:
    * "ti,bq24190"
    * "ti,bq24192"
    * "ti,bq24192i"
    * "ti,bq24196"
- reg: integer, I2C address of the charger.
- interrupts[-extended]: configuration for charger INT pin.

Optional properties:
- monitored-battery: phandle of battery characteristics devicetree node
  The charger uses the following battery properties:
    + precharge-current-microamp: maximum charge current during precharge
      phase (typically 20% of battery capacity).
    + charge-term-current-microamp: a charge cycle terminates when the
      battery voltage is above recharge threshold, and the current is below
      this setting (typically 10% of battery capacity).
  See also Documentation/devicetree/bindings/power/supply/battery.txt
- ti,system-minimum-microvolt: when power is connected and the battery is below
  minimum system voltage, the system will be regulated above this setting.

child nodes:
- usb-otg-vbus:
  Usage: optional
  Description: Regulator that is used to control the VBUS voltage direction for
               either USB host mode or for charging on the OTG port.

Notes:
- Some circuit boards wire the chip's "OTG" pin high (enabling 500mA default
  charge current on USB SDP ports, among other features). To simulate this on
  boards that wire the pin to a GPIO, set a gpio-hog.

Example:

	bat: battery {
		compatible = "simple-battery";
		precharge-current-microamp = <256000>;
		charge-term-current-microamp = <128000>;
		// etc.
	};

	bq24190: charger@6a {
		compatible = "ti,bq24190";
		reg = <0x6a>;
		interrupts-extended = <&gpiochip 10 IRQ_TYPE_EDGE_FALLING>;
		monitored-battery = <&bat>;
		ti,system-minimum-microvolt = <3200000>;

		usb_otg_vbus: usb-otg-vbus { };
	};

	&twl_gpio {
		otg {
			gpio-hog;
			gpios = <6 0>;
			output-high;
			line-name = "otg-gpio";
		};
	};
+92 −0
Original line number Diff line number Diff line
# SPDX-License-Identifier: GPL-2.0
# Copyright (C) 2021 Sebastian Reichel
%YAML 1.2
---
$id: "http://devicetree.org/schemas/power/supply/bq24190.yaml#"
$schema: "http://devicetree.org/meta-schemas/core.yaml#"

title: Binding for TI BQ2419x Li-Ion Battery Charger

maintainers:
  - Sebastian Reichel <sre@kernel.org>

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

properties:
  compatible:
    enum:
      - ti,bq24190
      - ti,bq24192
      - ti,bq24192i
      - ti,bq24196

  reg:
    maxItems: 1

  interrupts:
    maxItems: 1

  usb-otg-vbus:
    type: object
    description: |
      Regulator that is used to control the VBUS voltage direction for
      either USB host mode or for charging on the OTG port

  ti,system-minimum-microvolt:
    description: |
      when power is connected and the battery is below minimum system voltage,
      the system will be regulated above this setting.

  omit-battery-class:
    type: boolean
    description: |
      If this property is set, the operating system does not try to create a
      battery device.

  monitored-battery:
    $ref: /schemas/types.yaml#/definitions/phandle
    description: |
      phandle to a "simple-battery" compatible node.

      This property must be a phandle to a node using the format described
      in battery.yaml, with the following properties being required:
      - precharge-current-microamp: maximum charge current during precharge phase
                                    (typically 20% of battery capacity).
      - charge-term-current-microamp: a charge cycle terminates when the battery voltage is
                                      above recharge threshold, and the current is below this
                                      setting (typically 10% of battery capacity).

required:
  - compatible
  - reg
  - interrupts

additionalProperties: false

examples:
  - |
    #include <dt-bindings/gpio/gpio.h>
    #include <dt-bindings/interrupt-controller/irq.h>

    bat: battery {
      compatible = "simple-battery";
      precharge-current-microamp = <256000>;
      charge-term-current-microamp = <128000>;
    };

    i2c0 {
      #address-cells = <1>;
      #size-cells = <0>;

      charger@6a {
        compatible = "ti,bq24190";
        reg = <0x6a>;
        interrupt-parent = <&gpiochip>;
        interrupts = <10 IRQ_TYPE_EDGE_FALLING>;
        monitored-battery = <&bat>;
        ti,system-minimum-microvolt = <3200000>;

        usb_otg_vbus: usb-otg-vbus { };
      };
    };