diff mbox series

[1/2] dt-bindings: hwmon: adi,ltc2945: Add binding

Message ID 20221214220727.1350784-2-jcormier@criticallink.com
State New
Headers
Series hwmon: ltc2945: Add binding and shunt resistor support |

Commit Message

Jonathan Cormier Dec. 14, 2022, 10:07 p.m. UTC 
  Signed-off-by: "Cormier, Jonathan" <jcormier@criticallink.com>
---
 .../bindings/hwmon/adi,ltc2945.yaml           | 50 +++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/hwmon/adi,ltc2945.yaml

Comments

Krzysztof Kozlowski Dec. 15, 2022, 9:42 a.m. UTC | #1 
On 14/12/2022 23:07, Cormier, Jonathan wrote:

Missing commit msg. Describe hardware.



> Signed-off-by: "Cormier, Jonathan" <jcormier@criticallink.com>
> ---
>  .../bindings/hwmon/adi,ltc2945.yaml           | 50 +++++++++++++++++++
>  1 file changed, 50 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/hwmon/adi,ltc2945.yaml
> 
> diff --git a/Documentation/devicetree/bindings/hwmon/adi,ltc2945.yaml b/Documentation/devicetree/bindings/hwmon/adi,ltc2945.yaml
> new file mode 100644
> index 000000000000..9ca7a886dec8
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/hwmon/adi,ltc2945.yaml
> @@ -0,0 +1,50 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/hwmon/adi,ltc2945.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Analog Devices LTC2945 wide range i2c power monitor
> +
> +maintainers:
> +  - Guenter Roeck <linux@roeck-us.net>
> +
> +description: |
> +  Analog Devices LTC2945 wide range i2c power monitor over I2C.
> +
> +  https://www.analog.com/media/en/technical-documentation/data-sheets/LTC2945.pdf
> +
> +properties:
> +  compatible:
> +    enum:
> +      - ltc2945

That's not a correct compatible. Missing vendor prefix.

> +
> +  reg:
> +    maxItems: 1
> +
> +  shunt-resistor-micro-ohms:
> +    description:
> +      Shunt resistor value in micro-Ohms
> +    default: 1000
> +
> +required:
> +  - compatible
> +  - reg
> +
> +

Just one blank line.

> +additionalProperties: false
> +
> +examples:
> +  - |
> +    i2c {
> +           #address-cells = <1>;
> +           #size-cells = <0>;

Use 4 spaces for example indentation.

> +
> +           ltc2945_i2c: ltc2945@6e {

Node names should be generic.
https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation

> +              compatible = "ltc2945";
> +              reg = <0x6e>;
> +              /* 10 milli-Ohm shunt resistor */
> +              shunt-resistor-micro-ohms = <10000>;
> +           };
> +    };
> +...

Best regards,
Krzysztof
Jonathan Cormier Dec. 15, 2022, 2:37 p.m. UTC | #2 
Resending reply in plain text

On Thu, Dec 15, 2022 at 9:35 AM Jon Cormier <jcormier@criticallink.com> wrote:
>
> On Thu, Dec 15, 2022 at 4:42 AM Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> wrote:
>>
>> On 14/12/2022 23:07, Cormier, Jonathan wrote:
>>
>> Missing commit msg. Describe hardware.
>
> Thanks
>>
>>
>>
>>
>> > Signed-off-by: "Cormier, Jonathan" <jcormier@criticallink.com>
>> > ---
>> >  .../bindings/hwmon/adi,ltc2945.yaml           | 50 +++++++++++++++++++
>> >  1 file changed, 50 insertions(+)
>> >  create mode 100644 Documentation/devicetree/bindings/hwmon/adi,ltc2945.yaml
>> >
>> > diff --git a/Documentation/devicetree/bindings/hwmon/adi,ltc2945.yaml b/Documentation/devicetree/bindings/hwmon/adi,ltc2945.yaml
>> > new file mode 100644
>> > index 000000000000..9ca7a886dec8
>> > --- /dev/null
>> > +++ b/Documentation/devicetree/bindings/hwmon/adi,ltc2945.yaml
>> > @@ -0,0 +1,50 @@
>> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>> > +%YAML 1.2
>> > +---
>> > +$id: http://devicetree.org/schemas/hwmon/adi,ltc2945.yaml#
>> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> > +
>> > +title: Analog Devices LTC2945 wide range i2c power monitor
>> > +
>> > +maintainers:
>> > +  - Guenter Roeck <linux@roeck-us.net>
>> > +
>> > +description: |
>> > +  Analog Devices LTC2945 wide range i2c power monitor over I2C.
>> > +
>> > +  https://www.analog.com/media/en/technical-documentation/data-sheets/LTC2945.pdf
>> > +
>> > +properties:
>> > +  compatible:
>> > +    enum:
>> > +      - ltc2945
>>
>> That's not a correct compatible. Missing vendor prefix.
>>
> Okay, I assume I'll need to update the driver as well to handle that.
>>
>> > +
>> > +  reg:
>> > +    maxItems: 1
>> > +
>> > +  shunt-resistor-micro-ohms:
>> > +    description:
>> > +      Shunt resistor value in micro-Ohms
>> > +    default: 1000
>> > +
>> > +required:
>> > +  - compatible
>> > +  - reg
>> > +
>> > +
>>
>> Just one blank line.
>>
>> > +additionalProperties: false
>> > +
>> > +examples:
>> > +  - |
>> > +    i2c {
>> > +           #address-cells = <1>;
>> > +           #size-cells = <0>;
>>
>> Use 4 spaces for example indentation.
>>
>> > +
>> > +           ltc2945_i2c: ltc2945@6e {
>>
>> Node names should be generic.
>> https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation
>>
>> > +              compatible = "ltc2945";
>> > +              reg = <0x6e>;
>> > +              /* 10 milli-Ohm shunt resistor */
>> > +              shunt-resistor-micro-ohms = <10000>;
>> > +           };
>> > +    };
>> > +...
>>
>> Best regards,
>> Krzysztof
>>
>
>
> --
> Jonathan Cormier
> Software Engineer
>
> Voice:  315.425.4045 x222
>
>
>
> http://www.CriticalLink.com
> 6712 Brooklawn Parkway, Syracuse, NY 13211
>
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/hwmon/adi,ltc2945.yaml b/Documentation/devicetree/bindings/hwmon/adi,ltc2945.yaml
new file mode 100644
index 000000000000..9ca7a886dec8
--- /dev/null
+++ b/Documentation/devicetree/bindings/hwmon/adi,ltc2945.yaml
@@ -0,0 +1,50 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/hwmon/adi,ltc2945.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Analog Devices LTC2945 wide range i2c power monitor
+
+maintainers:
+  - Guenter Roeck <linux@roeck-us.net>
+
+description: |
+  Analog Devices LTC2945 wide range i2c power monitor over I2C.
+
+  https://www.analog.com/media/en/technical-documentation/data-sheets/LTC2945.pdf
+
+properties:
+  compatible:
+    enum:
+      - ltc2945
+
+  reg:
+    maxItems: 1
+
+  shunt-resistor-micro-ohms:
+    description:
+      Shunt resistor value in micro-Ohms
+    default: 1000
+
+required:
+  - compatible
+  - reg
+
+
+additionalProperties: false
+
+examples:
+  - |
+    i2c {
+           #address-cells = <1>;
+           #size-cells = <0>;
+
+           ltc2945_i2c: ltc2945@6e {
+              compatible = "ltc2945";
+              reg = <0x6e>;
+              /* 10 milli-Ohm shunt resistor */
+              shunt-resistor-micro-ohms = <10000>;
+           };
+    };
+...