linux-kernel - Re: [RESEND 2/2] dt-bindings: power: supply: cw2015_battery: add device tree binding documentation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <20200115020155.GA7802@bogus>
Date:   Tue, 14 Jan 2020 20:01:55 -0600
From:   Rob Herring <robh@...nel.org>
To:     Tobias Schramm <t.schramm@...jaro.org>
Cc:     Sebastian Reichel <sre@...nel.org>,
        Mark Rutland <mark.rutland@....com>, linux-pm@...r.kernel.org,
        devicetree@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [RESEND 2/2] dt-bindings: power: supply: cw2015_battery: add
 device tree binding documentation

On Thu, Jan 09, 2020 at 12:39:55PM +0100, Tobias Schramm wrote:
> This patch adds the ds binding document for the cw2015 Fuel Gauge.

ds?

> 
> Signed-off-by: Tobias Schramm <t.schramm@...jaro.org>
> ---
>  .../bindings/power/supply/cw2015_battery.txt  | 37 +++++++++++++++++++
>  1 file changed, 37 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/power/supply/cw2015_battery.txt

Please make this a DT schema. See 
Documentation/devicetree/writing-schema.rst.

> 
> diff --git a/Documentation/devicetree/bindings/power/supply/cw2015_battery.txt b/Documentation/devicetree/bindings/power/supply/cw2015_battery.txt
> new file mode 100644
> index 000000000000..e847391268f3
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/power/supply/cw2015_battery.txt
> @@ -0,0 +1,37 @@
> +cw2015_battery
> +~~~~~~~~~~~~~~~~
> +
> +The cellwise CW2015 is a shuntless single/multi-cell battery fuel gauge.
> +
> +Required properties :
> + - compatible : "cellwise,cw2015"
> + - cellwise,bat-config-info : Binary battery info blob
> +
> +Optional properties :
> + - cellwise,monitor-interval : Measurement interval in seconds

Use standard unit suffix.

> + - cellwise,voltage-divider : Voltage divider for multi-cell packs,
> +   specified as two integer values <high side>, <low side> in ohms.

Use standard unit suffix (-ohms).

> + - cellwise,virtual-power : Default to disconnected battery state (gauge in pack mode)
> + - cellwise,design-capacity : Design capacity of the battery cell in milliampere hours

I think we have a standard property for this. Properties of the battery 
should be in a battery node.

> + - cellwise,alert-level : Low battery alarm level in percent
> +
> +Example:
> +	cw2015@62 {
> +		status = "okay";

Don't show status in examples.

> +		compatible = "cellwise,cw201x";
> +		reg = <0x62>;
> +		cellwise,bat-config-info = <
> +			0x17 0x67 0x80 0x73 0x6E 0x6C 0x6B 0x63
> +			0x77 0x51 0x5C 0x58 0x50 0x4C 0x48 0x36
> +			0x15 0x0C 0x0C 0x19 0x5B 0x7D 0x6F 0x69
> +			0x69 0x5B 0x0C 0x29 0x20 0x40 0x52 0x59
> +			0x57 0x56 0x54 0x4F 0x3B 0x1F 0x7F 0x17
> +			0x06 0x1A 0x30 0x5A 0x85 0x93 0x96 0x2D
> +			0x48 0x77 0x9C 0xB3 0x80 0x52 0x94 0xCB
> +			0x2F 0x00 0x64 0xA5 0xB5 0x11 0xF0 0x11
> +		>;
> +		cellwise,monitor-interval = <5>;
> +		cellwise,virtual-power;
> +		cellwise,design-capacity = <9800>;
> +		power-supplies = <&mains_charger>, <&usb_charger>;

Not documented.

> +	}
> -- 
> 2.24.1
>