# SPDX-License-Identifier: GPL-2.0
%YAML 1.2
---
$id: http://devicetree.org/schemas/power/supply/maxim,max8903.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Maxim Semiconductor MAX8903 Battery Charger

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

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

properties:
  compatible:
    const: maxim,max8903

  dok-gpios:
    maxItems: 1
    description: Valid DC power has been detected (active low, input)

  uok-gpios:
    maxItems: 1
    description: Valid USB power has been detected (active low, input)

  cen-gpios:
    maxItems: 1
    description: Charge enable pin (active low, output)

  chg-gpios:
    maxItems: 1
    description: Charger status pin (active low, input)

  flt-gpios:
    maxItems: 1
    description: Fault pin (active low, input)

  dcm-gpios:
    maxItems: 1
    description: Current limit mode setting (DC=1 or USB=0, output)

  usus-gpios:
    maxItems: 1
    description: USB suspend pin (active high, output)

  dc-current-limit-gpios:
    minItems: 1
    maxItems: 4
    description:
      GPIOs controlling DC input current limit via resistor mux.
      Used with dc-current-limit-mapping to select charging current.

  dc-current-limit-mapping:
    $ref: /schemas/types.yaml#/definitions/uint32-matrix
    minItems: 2
    maxItems: 16
    description: |
      Array of (current_microamps, gpio_bit_pattern) pairs defining available
      DC current limits. The gpio_bit_pattern is applied to dc-current-limit-gpios
      to select that current level.
    items:
      items:
        - description: Current limit in microamps
        - description: GPIO bit pattern value

  usb-current-limit-gpios:
    maxItems: 1
    description:
      GPIO driving the MAX8903 IUSB pin. IUSB is a silicon-fixed
      two-state input - low selects 100 mA, high selects 500 mA.
      Only the GPIO mapping is board-specific.

required:
  - compatible

dependentRequired:
  dc-current-limit-gpios: [dc-current-limit-mapping]
  dc-current-limit-mapping: [dc-current-limit-gpios]

anyOf:
  - required:
      - dok-gpios
  - required:
      - uok-gpios

additionalProperties: false

examples:
  - |
    #include <dt-bindings/gpio/gpio.h>
    charger {
      compatible = "maxim,max8903";
      dok-gpios = <&gpio2 3 GPIO_ACTIVE_LOW>;
      flt-gpios = <&gpio2 2 GPIO_ACTIVE_LOW>;
      chg-gpios = <&gpio3 15 GPIO_ACTIVE_LOW>;
      cen-gpios = <&gpio2 5 GPIO_ACTIVE_LOW>;
    };
  - |
    /* Example with DC and USB current limit control */
    #include <dt-bindings/gpio/gpio.h>
    charger {
      compatible = "maxim,max8903";
      dok-gpios = <&gpio2 3 GPIO_ACTIVE_LOW>;
      flt-gpios = <&gpio2 2 GPIO_ACTIVE_LOW>;
      chg-gpios = <&gpio3 15 GPIO_ACTIVE_LOW>;
      cen-gpios = <&gpio2 5 GPIO_ACTIVE_LOW>;
      dcm-gpios = <&gpio2 6 GPIO_ACTIVE_HIGH>;

      /* DC input current limit via IDC resistor mux */
      dc-current-limit-gpios = <&gpio1 0 GPIO_ACTIVE_HIGH>,
                               <&gpio1 1 GPIO_ACTIVE_HIGH>;
      dc-current-limit-mapping = <750000 0>,  /* GPIO[1:0]=0b00 */
                                 <900000 1>,  /* GPIO[1:0]=0b01 */
                                 <1400000 3>, /* GPIO[1:0]=0b11 */
                                 <2000000 2>; /* GPIO[1:0]=0b10 */

      /* USB current limit: IUSB pin, 100 mA (low) / 500 mA (high) */
      usb-current-limit-gpios = <&gpio1 2 GPIO_ACTIVE_HIGH>;
    };