Re: [PATCH v5 1/4] hwmon: ltc2978: device tree bindings documentation

Guenter Roeck
2014-10-03T23:23:36Z

On 10/03/2014 04:13 PM, Mark Brown wrote:
> On Fri, Oct 03, 2014 at 10:28:59AM -0700, Guenter Roeck wrote:
>> On 10/03/2014 05:27 AM, Mark Rutland wrote:
>
>>>> +Optional properties:
>>>> + Name of the optional regulator subnode must be "regulators".
>>>> + - #address-cells must be 1.
>
>>> What's the single address cell used for?
>
>> I think this is required by the regulator bindings.
>> Other regulators use the same, though they don't typically
>> mention it in the properties list but only in the examples.
>
> Nope, nothing to do with regulator that I'm aware of and I've not seen
> any examples (but I don't tend to review users too often).
>

Many examples, really. Just picking one.

Documentation/devicetree/bindings/mfd/tps6507x.txt

regulators {
#address-cells = <1>;
#size-cells = <0>;
...

This also uses the reg property for the regulator index
(without explaining it further). Seems to be pretty common.

Guenter

>>> Mark, what's the preferred scheme for identifying regulators in a
>>> container node?
>
>>>> + - regulator-name: arbitrary name for regulator
>
>>> Drop the 'aribtarary'. Either this should be the name of the regulator
>>> on the board, or it shouldn't be necessary.
>
>> Not sure if it even needs to be documented here. It is already documented
>> in Documentation/devicetree/bindings/regulator/regulator.txt.
>
> Document by reference then? It really should be the name of the supply
> provided by the regulator, that wording is probably good. Given that
> it's a standard regulator property I'd not document it here at all, just
> refer to the generic bindings and say any suitable properties there can
> be used.
>