From: Chanh Nguyen <chanh@amperemail.onmicrosoft.com>
To: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>,
Chanh Nguyen <chanh@os.amperecomputing.com>,
Jean Delvare <jdelvare@suse.com>,
Guenter Roeck <linux@roeck-us.net>,
Rob Herring <robh+dt@kernel.org>,
Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
Conor Dooley <conor+dt@kernel.org>,
Justin Ledford <justinledford@google.com>,
devicetree@vger.kernel.org, linux-hwmon@vger.kernel.org,
linux-kernel@vger.kernel.org,
OpenBMC Maillist <openbmc@lists.ozlabs.org>,
Open Source Submission <patches@amperecomputing.com>
Cc: Phong Vo <phong@os.amperecomputing.com>,
Thang Nguyen <thang@os.amperecomputing.com>,
Quan Nguyen <quan@os.amperecomputing.com>
Subject: Re: [PATCH 1/3] dt-bindings: hwmon: Add maxim max31790 driver bindings
Date: Fri, 22 Mar 2024 16:53:28 +0700 [thread overview]
Message-ID: <21256600-d94d-4287-b22f-f22258121668@amperemail.onmicrosoft.com> (raw)
In-Reply-To: <a224e752-d99b-45d3-b5db-761a698c347e@linaro.org>
On 18/03/2024 17:00, Krzysztof Kozlowski wrote:
> On 18/03/2024 10:51, Chanh Nguyen wrote:
>>
>>> It does not look like you tested the bindings, at least after quick
>>> look. Please run `make dt_binding_check` (see
>>> Documentation/devicetree/bindings/writing-schema.rst for instructions).
>>> Maybe you need to update your dtschema and yamllint.
>>>
>>
>>
>> I tested the binding, I didn't see any warning/error log. Please review
>> my logs as below
>
> Hm, I don't remember what brought my attention to possible error. Maybe
> I mistyped my template.
>
>>
>> => make dt_binding_check DT_SCHEMA_FILES=/hwmon/max31790.yaml
>> make[1]: Entering directory '/DISK4T/work/community/linux/out'
>> DTEX Documentation/devicetree/bindings/hwmon/max31790.example.dts
>> DTC_CHK Documentation/devicetree/bindings/hwmon/max31790.example.dtb
>> make[1]: Leaving directory '/DISK4T/work/community/linux/out'
>>
>>>>
>>>> Signed-off-by: Chanh Nguyen <chanh@os.amperecomputing.com>
>>>> ---
>>>> .../devicetree/bindings/hwmon/max31790.yaml | 44 +++++++++++++++++++
>>>> 1 file changed, 44 insertions(+)
>>>> create mode 100644 Documentation/devicetree/bindings/hwmon/max31790.yaml
>>>>
>>>> diff --git a/Documentation/devicetree/bindings/hwmon/max31790.yaml b/Documentation/devicetree/bindings/hwmon/max31790.yaml
>>>> new file mode 100644
>>>> index 000000000000..5a93e6bdebda
>>>> --- /dev/null
>>>> +++ b/Documentation/devicetree/bindings/hwmon/max31790.yaml
>>>
>>> Filename like compatible.
>>
>> Yes, I'll update that in v2
>>
>>>
>>>> @@ -0,0 +1,44 @@
>>>> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
>>>> +%YAML 1.2
>>>> +---
>>>> +$id: http://devicetree.org/schemas/hwmon/max31790.yaml#
>>>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>>>> +
>>>> +title: The Maxim MAX31790 Fan Controller
>>>> +
>>>> +maintainers:
>>>> + - Jean Delvare <jdelvare@suse.com>
>>>> + - Guenter Roeck <linux@roeck-us.net>
>>>
>>> You should have here someone responsible for hardware, not subsystem
>>> maintainers.
>>>
>>
>> Hi Krzysztof,
>> I checked the history of the drivers/hwmon/max31790.c and see Guenter
>> Roeck <linux@roeck-us.net> as an important maintainer. I saw many
>> commits from him. So, I add him to maintainer list.
>
> OK
>
>>
>>>> +
>>>> +description: >
>>>> + The MAX31790 controls the speeds of up to six fans using six
>>>> + independent PWM outputs. The desired fan speeds (or PWM duty cycles)
>>>> + are written through the I2C interface.
>>>> +
>>>> + Datasheets:
>>>> + https://datasheets.maximintegrated.com/en/ds/MAX31790.pdf
>>>> +
>>>> +properties:
>>>> + compatible:
>>>> + const: maxim,max31790
>>>> +
>>>> + reg:
>>>> + maxItems: 1
>>>
>>> That's weirdly empty.
>>>
>>
>> Hi Krzysztof,
>> I have not yet understood your comment here. Please help give more
>> details for my missing! Thank Krzysztof!
>
> I expect many more properties of a fan controller. Resources (clocks,
> PWMs, supplies) and FAN specific properties.
>
Hi Krzysztof,
I'm creating a base binding document for the max31790 driver. I'm basing
it on the drivers/hwmon/max31790.c. Currently, the max31790.c driver has
not yet implemented other properties, such as clocks, fan-supply, pwms,
etc. So I just introduced the "compatible" and "reg" properties.
In the near future, if any other properties are necessary, I think we
will implement them in drivers/hwmon/max31790.c then update this binding
document.
I look at other binding documents, I also see something similar. They
just introduce the "compatible" and "reg" properties.
https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git/tree/Documentation/devicetree/bindings/hwmon/adi,max31760.yaml
https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git/tree/Documentation/devicetree/bindings/hwmon/adt7475.yaml
https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git/tree/Documentation/devicetree/bindings/hwmon/adi,ad741x.yaml
This is only my view. It's a pleasure to hear your advice. Thanks!
>
>>>> +
>>>> +required:
>>>> + - compatible
>>>> + - reg
>>>> +
>>>
>>> You miss allOf: with $ref to fan controller schema.
>>>
>>
>> Thank Krzysztof,
>> I'll add the allOf at v2.
>>
>>>> +additionalProperties: false
>>>> +
>>>> +examples:
>>>> + - |
>>>> + i2c {
>>>> + #address-cells = <1>;
>>>> + #size-cells = <0>;
>>>> +
>>>> + max31790@20 {
>>>
>>> Node names should be generic. See also an explanation and list of
>>> examples (not exhaustive) in DT specification:
>>> https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation
>>>
>>
>> I suggest some node names, such as "i2c-fan" or "fan-controller" . Can
>> you please share your ideas with me!
>
> Look at recent commits and patches for similar type of a device.
>
Hi Krzysztof,
I checked on recent commits and found something of a similar type.
adi,max31760.yaml
fan-controller@50 {
reg = <0x50>;
compatible = "adi,max31760";
};
hpe,gxp-fan-ctrl.yaml
fan-controller@1000c00 {
compatible = "hpe,gxp-fan-ctrl";
reg = <0x1000c00 0x200>, <0xd1000000 0xff>, <0x80200000 0x100000>;
reg-names = "base", "pl", "fn2";
};
adi,axi-fan-control.yaml
axi_fan_control: axi-fan-control@80000000 {
compatible = "adi,axi-fan-control-1.00.a";
reg = <0x0 0x80000000 0x10000>;
clocks = <&clk 71>;
interrupts = <0 110 0>;
pulses-per-revolution = <2>;
};
I think "fan-controller" is a good node name. Do you think so?
> Best regards,
> Krzysztof
>
next prev parent reply other threads:[~2024-03-22 9:53 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-11 11:13 [PATCH 0/3] Update the max31790 driver Chanh Nguyen
2024-03-11 11:13 ` [PATCH 1/3] dt-bindings: hwmon: Add maxim max31790 driver bindings Chanh Nguyen
2024-03-11 16:55 ` Krzysztof Kozlowski
2024-03-18 9:51 ` Chanh Nguyen
2024-03-18 10:00 ` Krzysztof Kozlowski
2024-03-22 9:53 ` Chanh Nguyen [this message]
2024-03-25 8:32 ` Krzysztof Kozlowski
2024-03-26 10:26 ` Chanh Nguyen
2024-03-11 11:13 ` [PATCH 2/3] hwmon: (max31790): Support config PWM output becomes TACH Chanh Nguyen
2024-03-11 11:13 ` [PATCH 3/3] dt-bindings: hwmon: max31790: Add pwmout-pin-as-tach-input property Chanh Nguyen
2024-03-11 16:56 ` Krzysztof Kozlowski
2024-03-18 9:48 ` Chanh Nguyen
2024-03-18 10:02 ` Krzysztof Kozlowski
2024-03-18 16:50 ` Chanh Nguyen
2024-03-11 17:34 ` Rob Herring
2024-03-11 17:52 ` Guenter Roeck
2024-03-18 9:54 ` Chanh Nguyen
2024-03-18 9:53 ` Chanh Nguyen
2024-03-26 10:33 ` Chanh Nguyen
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=21256600-d94d-4287-b22f-f22258121668@amperemail.onmicrosoft.com \
--to=chanh@amperemail.onmicrosoft.com \
--cc=chanh@os.amperecomputing.com \
--cc=conor+dt@kernel.org \
--cc=devicetree@vger.kernel.org \
--cc=jdelvare@suse.com \
--cc=justinledford@google.com \
--cc=krzysztof.kozlowski+dt@linaro.org \
--cc=krzysztof.kozlowski@linaro.org \
--cc=linux-hwmon@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@roeck-us.net \
--cc=openbmc@lists.ozlabs.org \
--cc=patches@amperecomputing.com \
--cc=phong@os.amperecomputing.com \
--cc=quan@os.amperecomputing.com \
--cc=robh+dt@kernel.org \
--cc=thang@os.amperecomputing.com \
/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 read-only IMAP folder(s) and NNTP newsgroup(s).