Linux Hardware Monitor development
 help / color / mirror / Atom feed
From: Krzysztof Kozlowski <krzk@kernel.org>
To: Leo Yang <leo.yang.sy0@gmail.com>,
	jdelvare@suse.com, linux@roeck-us.net, robh@kernel.org,
	krzk+dt@kernel.org, conor+dt@kernel.org, Leo-Yang@quantatw.com,
	corbet@lwn.net, Delphine_CC_Chiu@Wiwynn.com,
	linux-hwmon@vger.kernel.org, devicetree@vger.kernel.org,
	linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org
Subject: Re: [PATCH 1/2] dt-bindings: Add INA233 device
Date: Mon, 6 Jan 2025 11:50:07 +0100	[thread overview]
Message-ID: <abdd156e-0c9b-477f-877c-0309c84c9d5b@kernel.org> (raw)
In-Reply-To: <20250106071337.3017926-2-Leo-Yang@quantatw.com>

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@quantatw.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@quantatw.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:
> +    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.

> +
> +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

  reply	other threads:[~2025-01-06 10:50 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-01-06  7:13 [PATCH 0/2] hwmon: Add support for INA233 Leo Yang
2025-01-06  7:13 ` [PATCH 1/2] dt-bindings: Add INA233 device Leo Yang
2025-01-06 10:50   ` Krzysztof Kozlowski [this message]
2025-01-06 15:06     ` Guenter Roeck
2025-01-06 14:56   ` Rob Herring (Arm)
2025-01-06  7:13 ` [PATCH 2/2] hwmon: Add driver for TI INA233 Current and Power Monitor Leo Yang
2025-01-06  9:45   ` kernel test robot
2025-01-06 10:52   ` Krzysztof Kozlowski
2025-01-06 15:31   ` Guenter Roeck
2025-01-09  0:50     ` Leo Yang
2025-01-09  3:04       ` Guenter Roeck
2025-01-07 17:08   ` kernel test robot
2025-01-09 10:15   ` kernel test robot
2025-01-09 14:59   ` kernel test robot

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=abdd156e-0c9b-477f-877c-0309c84c9d5b@kernel.org \
    --to=krzk@kernel.org \
    --cc=Delphine_CC_Chiu@Wiwynn.com \
    --cc=Leo-Yang@quantatw.com \
    --cc=conor+dt@kernel.org \
    --cc=corbet@lwn.net \
    --cc=devicetree@vger.kernel.org \
    --cc=jdelvare@suse.com \
    --cc=krzk+dt@kernel.org \
    --cc=leo.yang.sy0@gmail.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-hwmon@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux@roeck-us.net \
    --cc=robh@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