Received-SPF: pass (google.com: domain of linux-kernel+bounces-111253-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.48.161 as permitted sender) client-ip=147.75.48.161;
Message-ID: <21256600-d94d-4287-b22f-f22258121668@amperemail.onmicrosoft.com>
Date: Fri, 22 Mar 2024 16:53:28 +0700
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH 1/3] dt-bindings: hwmon: Add maxim max31790 driver
 bindings
Content-Language: en-US
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>
References: <20240311111347.23067-1-chanh@os.amperecomputing.com>
 <20240311111347.23067-2-chanh@os.amperecomputing.com>
 <6fb70adb-aa85-4b9c-b093-afa4ec7ed056@linaro.org>
 <ab8b45c5-2ef0-4a87-87bf-f797954b4574@amperemail.onmicrosoft.com>
 <a224e752-d99b-45d3-b5db-761a698c347e@linaro.org>
From: Chanh Nguyen <chanh@amperemail.onmicrosoft.com>
In-Reply-To: <a224e752-d99b-45d3-b5db-761a698c347e@linaro.org>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?utf-8?B?Q2dUYlZrcFVib2ZPQ0hRbTRwNnAwQUxpNWt4QUQ5c0dqRyswUkt2TENtQ0N1?=
 =?utf-8?B?dWMyb3RvSFN0bnE1aFNHTnJIQXFDdmh5OE04T0E2VUNySUZDbGE2UHRST2FS?=
 =?utf-8?B?dEJBQk0wbmRoa0JTNUZ6a2tTWStoamRSRzVlR3hmUy8rejUyZWthUjVIWTho?=
 =?utf-8?B?STZQZ3pHQ1NqdklndHNRMFhKSGkrc29XTTFuWGNrVWt0NlpjWHdMUTlkd21C?=
 =?utf-8?B?Nm9DemlBWHRzNEJGb2k4eG5PTm9SemRBbHJlWHFuSk1KRDNqM1U5YWZBUVd3?=
 =?utf-8?B?LzVWc2FhUWlVNmtrdGhTS00xQ245Yyt2K2x2RW1BTUdOV09kbjFVS2pVcmlK?=
 =?utf-8?B?LzdsWHV3Zm16eXF0WHdyaWtLWTNTQzI5Slk0bWtHVlhzdDV5WlFWQm9BMWo3?=
 =?utf-8?B?RHYrVk1uZXpHRXBWUDlkNWpXSk5EbHR6V3hVdXp2OTJwOEc5eTJsanZGeGVE?=
 =?utf-8?B?SVN4QmI2amY3VndzZWtJanlCTjlKZ2dIMHozMU9UWlBFRy9yTGN2Zko5QzF6?=
 =?utf-8?B?NTZGTlk4NFJtc0hMUEczWmxhWW04akFVVUVmbE1iQ3NDYUZKZC9XOXdwbVF1?=
 =?utf-8?B?Y1EyUVVJQndWMW9TQXh4VVMvZ2srdjcyUXdyTU12clNSWlV5ejNHSERFekJJ?=
 =?utf-8?B?OUQwamtTVGppTkJTWWw0Wnl0Ri9hR1dTUzdEbnhzanIvTmlHOVhQenJUbFd6?=
 =?utf-8?B?bUpJU1ErOHhZYXI4RWszOWg5RDZ2dmtqRkVyeHhMTHI2Szh3NHdjVGdEOVRN?=
 =?utf-8?B?NU1ja21NQm1nTWFFSG42blQxeVV2clNRRi82akp6eDRYcG1YdVg1eWI3a1o1?=
 =?utf-8?B?WTJiL3ZrM1NaN2poOUZkM1VmMEFMQjhORFhFVzhnVi8wdVhMV1A4ZmtlcFBF?=
 =?utf-8?B?ck9FQkk4OW4zMjlKd0l4WFpuVllmd0Jvc29RcnhiSVpUaTFOZmM3R05INUR4?=
 =?utf-8?B?Y0xHdlVPWldIMUVmWDYybXplN09EdUV2QXZENVdnZ3B1aTM3Z2RseUVNd3B5?=
 =?utf-8?B?QzdnSno0RmdEbjRxZms1QnVPUXJTQ0dnbXplY3cxdWZ5NlRkVTZSbnc2TER3?=
 =?utf-8?B?SlBLL3pHdmQ5U0l5VGdSUTVQU1RSbVovZU5hczlySjEzT0lzc0Y3RzNSVWhB?=
 =?utf-8?B?blM5SktOVHR4S21VZlIxR25lMGxJcDZDZmxySkpuZDV6dzhLSFlZNmJsVndq?=
 =?utf-8?B?N1p2WVliUmhtcHg3ZmZYdXZ6ZmZDWnNyUHlYbjkrOEFJWnVoVEV3NFJTQ3BM?=
 =?utf-8?B?aHVSd1FnZ0hvdHZTNmZvYTIxQXpWUFhYR3ludENKYWNlRSsxamJCZkVnaWNz?=
 =?utf-8?B?Y3RYTzFmQm54MFZtV0hUZkc5ak0wd2t5TStQR0Z4Q05KMU5XWlVOc0FqOEND?=
 =?utf-8?B?NS9vQW0wSEp3TlJHeHJRbVNucnJoN1BBWXNIeEx5dStEb0RZSFgwRC9Xb0V4?=
 =?utf-8?B?U2FnNmRjaERjN2pDbitwcnoxc1plWkE5Z2hzcElUV2JtUTNGMXQ4VnRlUmcy?=
 =?utf-8?B?dXpRRGVPRE5JOXpYWnJBT3p5UDEwaVJLMFQ2dTJzMUpubkJuT01nMDBQcFlD?=
 =?utf-8?B?dGJlU2VLbEtIa3phK05mYUdqbnk2ZFU4MWlsMmUva0pYNkNzdm9GRVAzQnEx?=
 =?utf-8?B?S0lvdFNjcStmTS84T2ZGNUhSS3RUYW9kRXR6L2U2SDV4QlQralFmUnFmeDJr?=
 =?utf-8?B?aFVOVlF6U0lLaG4yTi95ZHhkSlZHeEZDRGZTamVGUVF2WXY2T2xTaWR0Ly9x?=
 =?utf-8?B?aC9YTFhXdVppNjF3VVFteHIzT0VKQ01WUVpnYmJWdU5mU1hFQXJraW5LSnRj?=
 =?utf-8?B?Vjh2UFVEVFZWeXJ1ZTZMSHZNUmxYMnVDbVlWV1lyMEJGQWIvYkIvMEMvc08v?=
 =?utf-8?B?SWRydnU4a0IwV1FET3BnSFR2LzdBTFFuTmk2YmRnUGJhcFNzRnlGVSt4dVJY?=
 =?utf-8?B?YmgxSTRsWnBVUDBPVUQ3Yy91SXRBWDJUbXpCVk1lWjNLTkVpbmNyK0kzTUdh?=
 =?utf-8?B?bnNDbDJ5K1pyQWc3eDBmK2wycy90dW1XK3JrRy95QVNpMWZ4MURsTTNVbVRt?=
 =?utf-8?B?VmdkNExGNDBFdmdBeVNudmtoQ0xybHNyNzdMcXY3bys4TjYrWnNOaGEzV29o?=
 =?utf-8?B?V1dIYWtVYlpXMFVHeXppOUFyQ0VuR0V0Qk9lemdVMFBzMGhLMVB4MVNMN2Nr?=
 =?utf-8?Q?SbVVhXBh38v9XsW7kefgFjc=3D?=
X-OriginatorOrg: amperemail.onmicrosoft.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 44a47a26-8412-42f8-8d3a-08dc4a55f29e
X-MS-Exchange-CrossTenant-AuthSource: DM6PR01MB5947.prod.exchangelabs.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 22 Mar 2024 09:53:38.6376
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 3bc2b170-fd94-476d-b0ce-4229bdc904a7
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: a4pkiwUNXc9TlDYog3ejAwkKZcHohafIbP+eNy3nG83xoK3iW9Pqcht0NvCkcIQJz+KMk38Sm6X9HbdVY1lZ6o5JsVlyXzrEIJvwpn1juYI/gBD5xnHk0cYCJQRzQ9cb
X-MS-Exchange-Transport-CrossTenantHeadersStamped: MW4PR01MB6129


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
>