Skip to content

Commit

Permalink
Documentation: Add sbs-manager device tree node documentation
Browse files Browse the repository at this point in the history
This patch adds device tree documentation for the sbs-manager

Signed-off-by: Karl-Heinz Schneider <karl-heinz@schneider-inet.de>
Signed-off-by: Phil Reid <preid@electromag.com.au>
Acked-by: Rob Herring <robh@kernel.org>
Reviewed-by: Sebastian Reichel <sebastian.reichel@collabora.co.uk>
Signed-off-by: Wolfram Sang <wsa@the-dreams.de>
  • Loading branch information
Karl-Heinz Schneider authored and Wolfram Sang committed Oct 28, 2017
1 parent e460617 commit 26b61a6
Showing 1 changed file with 66 additions and 0 deletions.
66 changes: 66 additions & 0 deletions Documentation/devicetree/bindings/power/supply/sbs,sbs-manager.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
Binding for sbs-manager

Required properties:
- compatible: "<vendor>,<part-number>", "sbs,sbs-charger" as fallback. The part
number compatible string might be used in order to take care of vendor
specific registers.
- reg: integer, i2c address of the device. Should be <0xa>.
Optional properties:
- gpio-controller: Marks the port as GPIO controller.
See "gpio-specifier" in .../devicetree/bindings/gpio/gpio.txt.
- #gpio-cells: Should be <2>. The first cell is the pin number, the second cell
is used to specify optional parameters:
See "gpio-specifier" in .../devicetree/bindings/gpio/gpio.txt.

From OS view the device is basically an i2c-mux used to communicate with up to
four smart battery devices at address 0xb. The driver actually implements this
behaviour. So standard i2c-mux nodes can be used to register up to four slave
batteries. Channels will be numerated starting from 1 to 4.

Example:

batman@a {
compatible = "lltc,ltc1760", "sbs,sbs-manager";
reg = <0x0a>;
#address-cells = <1>;
#size-cells = <0>;

gpio-controller;
#gpio-cells = <2>;

i2c@1 {
#address-cells = <1>;
#size-cells = <0>;
reg = <1>;

battery@b {
compatible = "ti,bq2060", "sbs,sbs-battery";
reg = <0x0b>;
sbs,battery-detect-gpios = <&batman 1 1>;
};
};

i2c@2 {
#address-cells = <1>;
#size-cells = <0>;
reg = <2>;

battery@b {
compatible = "ti,bq2060", "sbs,sbs-battery";
reg = <0x0b>;
sbs,battery-detect-gpios = <&batman 2 1>;
};
};

i2c@3 {
#address-cells = <1>;
#size-cells = <0>;
reg = <3>;

battery@b {
compatible = "ti,bq2060", "sbs,sbs-battery";
reg = <0x0b>;
sbs,battery-detect-gpios = <&batman 3 1>;
};
};
};

0 comments on commit 26b61a6

Please sign in to comment.