linux-kernel - Re: [PATCH v2 3/4] power_supply: tps65090-charger: Add binding doc

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 for Android: free password hash cracker in your pocket

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

Date:	Tue, 5 Mar 2013 14:12:38 -0500
From:	Rhyland Klein <rklein@...dia.com>
To:	Stephen Warren <swarren@...dotorg.org>
CC:	Grant Likely <grant.likely@...retlab.ca>,
	Samuel Ortiz <sameo@...ux.intel.com>,
	Anton Vorontsov <cbou@...l.ru>,
	Mark Brown <broonie@...nsource.wolfsonmicro.com>,
	"linux-tegra@...r.kernel.org" <linux-tegra@...r.kernel.org>,
	"devicetree-discuss@...ts.ozlabs.org" 
	<devicetree-discuss@...ts.ozlabs.org>,
	Laxman Dewangan <ldewangan@...dia.com>,
	"linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH v2 3/4] power_supply: tps65090-charger: Add binding doc

On 3/5/2013 1:15 PM, Stephen Warren wrote:
> On 03/04/2013 12:01 PM, Rhyland Klein wrote:
>> This change adds the binding documentation for the tps65090-charger.
>> diff --git a/Documentation/devicetree/bindings/power_supply/tps65090.txt b/Documentation/devicetree/bindings/power_supply/tps65090.txt
> ...
>> +Example:
>> +
>> +	tps65090@48 {
> ...
>> +		regulators {
>> +			...
>> +		};
>>
> The "regulators" node in the example isn't mentioned in the list of
> properties/nodes that's above. What goes in there? You probably want to
> include text similar to what I've quoted below from
> Documentation/devicetree/bindings/regulator/tps6586x.txt:
>
>> - regulators: A node that houses a sub-node for each regulator within the
>>    device. Each sub-node is identified using the node's name (or the deprecated
>>    regulator-compatible property if present), with valid values listed below.
>>    The content of each sub-node is defined by the standard binding for
>>    regulators; see regulator.txt.
>>    sys, sm[0-2], ldo[0-9] and ldo_rtc
The reason I didn't bother documenting the regulators node was that 
since this is a child device
driver of an mfd device, there is already a child driver for the 
regulators with its own documentation

https://patchwork.kernel.org/patch/2051381/

I wasn't sure how I should handle this, as splitting the bindings to 
make logic sense in the binding
layout (charger under power_supply, and  regulators under regulator) or 
combine them somehow
into a single documentation entry common to the device. The latter seems 
to make more sense to me,
but since there aren't any dt specific entries for the core mfd part 
currently, it doesn't have its own
documentation, and sticking the charger info under the regulators seemed 
backwards to me.

I thought doing it this way would be a good way of starting a discussion 
around how to handle this.

thanks for starting it Stephen :)

-rhyland

-- 
nvpublic

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/