From: Guenter Roeck <linux@roeck-us.net>
To: Nicolin Chen <nicoleotsuka@gmail.com>
Cc: jdelvare@suse.com, robh+dt@kernel.org, mark.rutland@arm.com,
corbet@lwn.net, afd@ti.com, linux-hwmon@vger.kernel.org,
devicetree@vger.kernel.org, linux-kernel@vger.kernel.org,
linux-doc@vger.kernel.org
Subject: Re: [PATCH v4 1/2] dt-bindings: hwmon: Add ina3221 documentation
Date: Sat, 22 Sep 2018 23:36:22 -0700 [thread overview]
Message-ID: <fe5c9570-70f8-d54d-509e-fce3733a4145@roeck-us.net> (raw)
In-Reply-To: <20180923060120.GA8872@Asurada-Nvidia.nvidia.com>
On 09/22/2018 11:01 PM, Nicolin Chen wrote:
> On Sat, Sep 22, 2018 at 10:45:49PM -0700, Guenter Roeck wrote:
>> On 09/22/2018 10:31 PM, Nicolin Chen wrote:
>>> On Sat, Sep 22, 2018 at 10:19:42PM -0700, Guenter Roeck wrote:
>>>>> +2) child nodes
>>>>> + Required properties:
>>>>> + - input-id: Must be 1, 2 or 3
>>>>> +
>>>>> + Optional properties:
>>>>> + - input-label: Name of the input source
Just noticed the "input-" here. Please just use "label".
>>>>> + - shunt-resistor: Shunt resistor value in micro-Ohm
>>>>> + - status: Should be "disabled" if no input source
>>>>> +
>>>>> + Example:
>>>>> +
>>>>> + input1 {
>>>>> + input-id = <0x1>;
>>>>
>>>> We'll have to find a better name for this. Feel free to look up examples in the
>>>> existing devicetree descriptions. The one that seems to be used most of the time
>>>> to indicate a channel index or id is "reg". It should also start with 0 - there
>>>> is no real reason for it to start with 1; it only makes the code more complex.
>>>
>>> The reason is that the port start from 1 in the datasheet.
>>>
>>
>> Maybe, but for me I'll want to have something that we can reuse for other chips.
>> Having the index start with 0 for one chip and with 1 for another would be
>> confusing. It is bad enough that we have in[0..n] for voltages and temp[1..n]
>> for temperatures. I would not want to see the same in devicetree files,
>> and much less so on a per-device basis. It is also pretty common to start
>> channel numbers with 0 in devicetree files.
>
> Understood. I search a bit and saw most of "*-id" start from 0,
> although I cannot be sure whether their Datasheet/RM/schematics
> are counting from 0 or 1.
>
> And I also found a transposing example:
> Documentation/devicetree/bindings/serial/mrvl,pxa-ssp.txt
>
You'll always find an example for anything in the kernel. In this case,
it is for one specific chip. I'll want this to be reusable as template for
_all_ hardware monitoring chips.
Thanks,
Guenter
> Probably should be better to wait for doc maintainers' input.
>
> Thanks
> Nicolin
>
next prev parent reply other threads:[~2018-09-23 6:36 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-09-23 4:11 [PATCH v4 0/2] Add an initial DT binding doc for ina3221 Nicolin Chen
2018-09-23 4:11 ` [PATCH v4 1/2] dt-bindings: hwmon: Add ina3221 documentation Nicolin Chen
2018-09-23 5:19 ` Guenter Roeck
2018-09-23 5:31 ` Nicolin Chen
2018-09-23 5:45 ` Guenter Roeck
2018-09-23 6:01 ` Nicolin Chen
2018-09-23 6:36 ` Guenter Roeck [this message]
2018-09-24 0:10 ` Nicolin Chen
2018-09-23 4:11 ` [PATCH v4 2/2] hwmon: ina3221: Read channel input source info from DT Nicolin Chen
2018-09-23 5:11 ` Guenter Roeck
2018-09-23 5:20 ` Nicolin Chen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=fe5c9570-70f8-d54d-509e-fce3733a4145@roeck-us.net \
--to=linux@roeck-us.net \
--cc=afd@ti.com \
--cc=corbet@lwn.net \
--cc=devicetree@vger.kernel.org \
--cc=jdelvare@suse.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-hwmon@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mark.rutland@arm.com \
--cc=nicoleotsuka@gmail.com \
--cc=robh+dt@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).