diff mbox series

[v5,1/2] dt-bindings: power: Add the bq25790 dt bindings

Message ID 20210202021747.717-2-r-rivera-matos@ti.com
State New
Headers show
Series Introduce the BQ25790 charger driver | expand

Commit Message

Ricardo Rivera-Matos Feb. 2, 2021, 2:17 a.m. UTC
From: Dan Murphy <dmurphy@ti.com>

Add the bindings for the bq25790.

Reviewed-by: Rob Herring <robh@kernel.org>
Signed-off-by: Ricardo Rivera-Matos <r-rivera-matos@ti.com>
Signed-off-by: Dan Murphy <dmurphy@ti.com>
---
 .../bindings/power/supply/bq25790.yaml        | 95 +++++++++++++++++++
 1 file changed, 95 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/power/supply/bq25790.yaml

Comments

Krzysztof Kozlowski Feb. 10, 2021, 8:38 a.m. UTC | #1
On Tue, 2 Feb 2021 at 03:20, Ricardo Rivera-Matos <r-rivera-matos@ti.com> wrote:
>

> From: Dan Murphy <dmurphy@ti.com>

>

> Add the bindings for the bq25790.

>

> Reviewed-by: Rob Herring <robh@kernel.org>

> Signed-off-by: Ricardo Rivera-Matos <r-rivera-matos@ti.com>

> Signed-off-by: Dan Murphy <dmurphy@ti.com>


Order of tags is entirely wrong. Did Rob review it before Dan write
it?  Your Sob should be after Dan's (unless you wrote it at first?).\

> ---

>  .../bindings/power/supply/bq25790.yaml        | 95 +++++++++++++++++++

>  1 file changed, 95 insertions(+)

>  create mode 100644 Documentation/devicetree/bindings/power/supply/bq25790.yaml

>

> diff --git a/Documentation/devicetree/bindings/power/supply/bq25790.yaml b/Documentation/devicetree/bindings/power/supply/bq25790.yaml

> new file mode 100644

> index 000000000000..6d9178ce5a2b

> --- /dev/null

> +++ b/Documentation/devicetree/bindings/power/supply/bq25790.yaml

> @@ -0,0 +1,95 @@

> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

> +# Copyright (C) 2020 Texas Instruments Incorporated

> +%YAML 1.2

> +---

> +$id: "http://devicetree.org/schemas/power/supply/bq25790.yaml#"

> +$schema: "http://devicetree.org/meta-schemas/core.yaml#"

> +

> +title: TI BQ25790 Switch Mode Buck-Boost Charger

> +

> +maintainers:

> +  - Dan Murphy <dmurphy@ti.com>

> +

> +description: |

> +  BQ25790 is a highly integrated switch-mode buck-boost charger for 1-4 cell

> +  Li-ion batteries and Li-polymer batteries. The device charges a battery from a

> +  wide range of input sources including legacy USB adapters to high voltage USB

> +  PD adapters and traditional barrel adapters.

> +

> +allOf:

> +  - $ref: power-supply.yaml#

> +

> +properties:

> +  compatible:

> +    enum:

> +      - ti,bq25790

> +      - ti,bq25792

> +

> +  reg:

> +    maxItems: 1

> +

> +  ti,watchdog-timeout-ms:

> +    default: 0

> +    description: |

> +      Watchdog timer in milli seconds. 0 (default) disables the watchdog.

> +    minimum: 0

> +    maximum: 160000


Why do you need minimum/maximum if you enumerate the values?

> +    enum: [ 0, 500, 1000, 2000, 20000, 40000, 80000, 160000]

> +

> +  input-voltage-limit-microvolt:

> +    description: |

> +      Minimum input voltage limit in micro volts with a 100000 micro volt step.

> +    minimum: 3600000

> +    maximum: 22000000

> +

> +  input-current-limit-microamp:

> +    description: |

> +      Maximum input current limit in micro amps with a 100000 micro amp step.

> +    minimum: 100000

> +    maximum: 3300000

> +

> +  monitored-battery:

> +    $ref: /schemas/types.yaml#/definitions/phandle

> +    description: phandle to the battery node being monitored

> +

> +  interrupts:

> +    maxItems: 1

> +    description: |

> +      Interrupt sends an active low, 256 μs pulse to host to report the charger

> +      device status and faults.

> +

> +required:

> +  - compatible

> +  - reg

> +  - monitored-battery

> +

> +unevaluatedProperties: false

> +

> +examples:

> +  - |

> +    bat: battery {

> +      compatible = "simple-battery";

> +      constant-charge-current-max-microamp = <2000000>;

> +      constant-charge-voltage-max-microvolt = <4200000>;

> +      precharge-current-microamp = <160000>;

> +      charge-term-current-microamp = <160000>;

> +    };

> +    #include <dt-bindings/gpio/gpio.h>

> +    #include <dt-bindings/interrupt-controller/irq.h>


Includes go to the beginning of example (and to beginning of DTS).

Best regards,
Krzysztof
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/power/supply/bq25790.yaml b/Documentation/devicetree/bindings/power/supply/bq25790.yaml
new file mode 100644
index 000000000000..6d9178ce5a2b
--- /dev/null
+++ b/Documentation/devicetree/bindings/power/supply/bq25790.yaml
@@ -0,0 +1,95 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+# Copyright (C) 2020 Texas Instruments Incorporated
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/power/supply/bq25790.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: TI BQ25790 Switch Mode Buck-Boost Charger
+
+maintainers:
+  - Dan Murphy <dmurphy@ti.com>
+
+description: |
+  BQ25790 is a highly integrated switch-mode buck-boost charger for 1-4 cell
+  Li-ion batteries and Li-polymer batteries. The device charges a battery from a
+  wide range of input sources including legacy USB adapters to high voltage USB
+  PD adapters and traditional barrel adapters.
+
+allOf:
+  - $ref: power-supply.yaml#
+
+properties:
+  compatible:
+    enum:
+      - ti,bq25790
+      - ti,bq25792
+
+  reg:
+    maxItems: 1
+
+  ti,watchdog-timeout-ms:
+    default: 0
+    description: |
+      Watchdog timer in milli seconds. 0 (default) disables the watchdog.
+    minimum: 0
+    maximum: 160000
+    enum: [ 0, 500, 1000, 2000, 20000, 40000, 80000, 160000]
+
+  input-voltage-limit-microvolt:
+    description: |
+      Minimum input voltage limit in micro volts with a 100000 micro volt step.
+    minimum: 3600000
+    maximum: 22000000
+
+  input-current-limit-microamp:
+    description: |
+      Maximum input current limit in micro amps with a 100000 micro amp step.
+    minimum: 100000
+    maximum: 3300000
+
+  monitored-battery:
+    $ref: /schemas/types.yaml#/definitions/phandle
+    description: phandle to the battery node being monitored
+
+  interrupts:
+    maxItems: 1
+    description: |
+      Interrupt sends an active low, 256 μs pulse to host to report the charger
+      device status and faults.
+
+required:
+  - compatible
+  - reg
+  - monitored-battery
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    bat: battery {
+      compatible = "simple-battery";
+      constant-charge-current-max-microamp = <2000000>;
+      constant-charge-voltage-max-microvolt = <4200000>;
+      precharge-current-microamp = <160000>;
+      charge-term-current-microamp = <160000>;
+    };
+    #include <dt-bindings/gpio/gpio.h>
+    #include <dt-bindings/interrupt-controller/irq.h>
+    i2c0 {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+      bq25790: charger@6b {
+          compatible = "ti,bq25790";
+          reg = <0x6b>;
+          interrupt-parent = <&gpio1>;
+          interrupts = <16 IRQ_TYPE_EDGE_FALLING>;
+          ti,watchdog-timeout-ms = <2000>;
+          input-current-limit-microamp = <3000000>;
+          input-voltage-limit-microvolt = <4500000>;
+          monitored-battery = <&bat>;
+      };
+    };
+
+...