linux-kernel - Re: [PATCH 1/2] dt-bindings: Add INA233 device

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: Windows password security audit tool. GUI, reports in PDF.

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

Message-ID: <b3d86db1-cea8-4a42-9401-6fe3291e727e@roeck-us.net>
Date: Mon, 6 Jan 2025 07:06:35 -0800
From: Guenter Roeck <linux@...ck-us.net>
To: Krzysztof Kozlowski <krzk@...nel.org>, Leo Yang <leo.yang.sy0@...il.com>,
 jdelvare@...e.com, robh@...nel.org, krzk+dt@...nel.org, conor+dt@...nel.org,
 Leo-Yang@...ntatw.com, corbet@....net, Delphine_CC_Chiu@...ynn.com,
 linux-hwmon@...r.kernel.org, devicetree@...r.kernel.org,
 linux-kernel@...r.kernel.org, linux-doc@...r.kernel.org
Subject: Re: [PATCH 1/2] dt-bindings: Add INA233 device

On 1/6/25 02:50, Krzysztof Kozlowski wrote:
> On 06/01/2025 08:13, Leo Yang wrote:
>> Add TI INA233 Current and Power Monitor bindings.
> 
> Please use subject prefixes matching the subsystem. You can get them for
> example with `git log --oneline -- DIRECTORY_OR_FILE` on the directory
> your patch is touching. For bindings, the preferred subjects are
> explained here:
> https://www.kernel.org/doc/html/latest/devicetree/bindings/submitting-patches.html#i-for-patch-submitters
> 
>>
>> Signed-off-by: Leo Yang <Leo-Yang@...ntatw.com>
>> ---
>>   .../bindings/hwmon/pmbus/ti,ina233.yaml       | 57 +++++++++++++++++++
>>   1 file changed, 57 insertions(+)
>>   create mode 100644 Documentation/devicetree/bindings/hwmon/pmbus/ti,ina233.yaml
>>
>> diff --git a/Documentation/devicetree/bindings/hwmon/pmbus/ti,ina233.yaml b/Documentation/devicetree/bindings/hwmon/pmbus/ti,ina233.yaml
>> new file mode 100644
>> index 000000000000..2677c98dadd1
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/hwmon/pmbus/ti,ina233.yaml
>> @@ -0,0 +1,57 @@
>> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +
> 
> Drop blank line
> 
>> +$id: http://devicetree.org/schemas/hwmon/pmbus/ti,ina233.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Texas Instruments INA233 of power/voltage/current monitors
>> +
>> +maintainers:
>> +  - Leo Yang <Leo-Yang@...ntatw.com>
>> +
>> +description: |
>> +  INA233 High-Side or Low-Side Measurement, Bidirectional Current
>> +  and Power Monitor With I2C-, SMBus-, and PMBus-Compatible Interface.
>> +
>> +  Datasheet: https://www.ti.com/lit/ds/symlink/ina233.pdf
>> +
>> +properties:
>> +  compatible:
>> +    enum:
>> +      - ti,ina233
> 
> This does not fit existing ti,ina bindings?
> 
>> +
>> +  reg:
>> +    maxItems: 1
>> +
>> +  shunt-resistor:

Should probably be shunt-resistor-micro-ohms.

>> +    description:
>> +      Shunt resistor value in micro-Ohms, Please refer to the actual circuit
>> +      resistor used.
>> +    default: 2000
> 
> Which schema brings the $ref for this property?
> 
>> +
>> +  current-lsb:
>> +    description:
>> +	    Calculate the Maximum Expected Current(A) / 2^15 in micro ampere (uA/bit).
>> +	    e.g. 30A / 2^15 = 915 uA/bit
>> +    default: 1000
> 
> Missing ref, missing vendor prefix and missing actual explanation what
> it is for. I don't understand the description at all.
> 

Also, the unit is missing.

>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +
>> +additionalProperties: false
>> +
>> +examples:
>> +  - |
>> +    i2c {
>> +        #address-cells = <1>;
>> +        #size-cells = <0>;
>> +
>> +        power-sensor@40 {
>> +            compatible = "ti,ina233";
>> +            reg = <0x40>;
>> +            shunt-resistor = /bits/ 32 <5000>;
> 
> Drop unusual syntax. Please take a look how all other bindings and DTS
> is doing this.
> 
>> +            current-lsb = /bits/ 16 <1000>;
>> +        };
>> +    };
>> \ No newline at end of file
> 
> You have patch errors.
> 
> Best regards,
> Krzysztof
>