diff mbox series

[v3,2/3] dt-bindings:iio:amplifiers: add ada4250 doc

Message ID 20220214094115.48548-2-antoniu.miclaus@analog.com (mailing list archive)
State Superseded
Headers show
Series [v3,1/3] iio:amplifiers:ada4250: add support for ADA4250 | expand

Commit Message

Miclaus, Antoniu Feb. 14, 2022, 9:41 a.m. UTC 
Add device tree bindings for the ADA4250 driver.

Signed-off-by: Antoniu Miclaus <antoniu.miclaus@analog.com>
---
 .../bindings/iio/amplifiers/adi,ada4250.yaml  | 48 +++++++++++++++++++
 1 file changed, 48 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/amplifiers/adi,ada4250.yaml

Comments

Jonathan Cameron Feb. 19, 2022, 6:50 p.m. UTC | #1 
On Mon, 14 Feb 2022 11:41:14 +0200
Antoniu Miclaus <antoniu.miclaus@analog.com> wrote:

> Add device tree bindings for the ADA4250 driver.
> 
> Signed-off-by: Antoniu Miclaus <antoniu.miclaus@analog.com>
> ---
>  .../bindings/iio/amplifiers/adi,ada4250.yaml  | 48 +++++++++++++++++++
>  1 file changed, 48 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/amplifiers/adi,ada4250.yaml
> 
> diff --git a/Documentation/devicetree/bindings/iio/amplifiers/adi,ada4250.yaml b/Documentation/devicetree/bindings/iio/amplifiers/adi,ada4250.yaml
> new file mode 100644
> index 000000000000..22283ab48903
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/amplifiers/adi,ada4250.yaml
> @@ -0,0 +1,48 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/amplifiers/adi,ada4250.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: ADA4250 Programmable Gain Instrumentation Amplifier
> +
> +maintainers:
> +  - Antoniu Miclaus <antoniu.miclaus@analog.com>
> +
> +description: |
> +  Precision Low Power, 110kHz, 26uA, Programmable Gain Instrumentation Amplifier.
> +
> +properties:
> +  compatible:
> +    enum:
> +      - adi,ada4250
> +
> +  reg:
> +    maxItems: 1
> +
> +  avdd-supply: true
> +
> +  adi,refbuf-enable:
> +    description:
> +      Enable internal buffer to drive the reference pin.
> +    type: boolean
> +
> +required:
> +  - compatible
> +  - reg
> +  - avdd-supply
> +
> +additionalProperties: false

Given it's an spi driver, probably want to add
spi-max-frequency: true to the allowed properties

Otherwise, lgtm
> +
> +examples:
> +  - |
> +    spi {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +      ada4250@0{
> +        compatible = "adi,ada4250";
> +        reg = <0>;
> +        avdd-supply = <&avdd>;
> +      };
> +    };
> +...
Krzysztof Kozlowski Feb. 20, 2022, 10:53 a.m. UTC | #2 
On 14/02/2022 10:41, Antoniu Miclaus wrote:
> Add device tree bindings for the ADA4250 driver.

Please put the bindings patch as first in the series.

> 
> Signed-off-by: Antoniu Miclaus <antoniu.miclaus@analog.com>
> ---
>  .../bindings/iio/amplifiers/adi,ada4250.yaml  | 48 +++++++++++++++++++
>  1 file changed, 48 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/amplifiers/adi,ada4250.yaml
> 
> diff --git a/Documentation/devicetree/bindings/iio/amplifiers/adi,ada4250.yaml b/Documentation/devicetree/bindings/iio/amplifiers/adi,ada4250.yaml
> new file mode 100644
> index 000000000000..22283ab48903
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/amplifiers/adi,ada4250.yaml
> @@ -0,0 +1,48 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/amplifiers/adi,ada4250.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: ADA4250 Programmable Gain Instrumentation Amplifier
> +
> +maintainers:
> +  - Antoniu Miclaus <antoniu.miclaus@analog.com>
> +
> +description: |
> +  Precision Low Power, 110kHz, 26uA, Programmable Gain Instrumentation Amplifier.
> +
> +properties:
> +  compatible:
> +    enum:
> +      - adi,ada4250
> +
> +  reg:
> +    maxItems: 1
> +
> +  avdd-supply: true

Needs a description, not a true.

As Jonathan said, you should allow spi-max-frequency (so
spi-max-frequency: true).

No io-channel-cells?

> +
> +  adi,refbuf-enable:
> +    description:
> +      Enable internal buffer to drive the reference pin.
> +    type: boolean
> +
> +required:
> +  - compatible
> +  - reg
> +  - avdd-supply
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    spi {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +      ada4250@0{

Generic node name, so "amplifier".

> +        compatible = "adi,ada4250";
> +        reg = <0>;
> +        avdd-supply = <&avdd>;
> +      };
> +    };
> +...


Best regards,
Krzysztof
Krzysztof Kozlowski Feb. 20, 2022, 11:42 a.m. UTC | #3 
On 20/02/2022 12:48, Jonathan Cameron wrote:
> On Sun, 20 Feb 2022 11:53:55 +0100
> Krzysztof Kozlowski <krzysztof.kozlowski@canonical.com> wrote:
> 
>> On 14/02/2022 10:41, Antoniu Miclaus wrote:
>>> Add device tree bindings for the ADA4250 driver.  
>>
>> Please put the bindings patch as first in the series.
>>
>>>
>>> Signed-off-by: Antoniu Miclaus <antoniu.miclaus@analog.com>
>>> ---
>>>  .../bindings/iio/amplifiers/adi,ada4250.yaml  | 48 +++++++++++++++++++
>>>  1 file changed, 48 insertions(+)
>>>  create mode 100644 Documentation/devicetree/bindings/iio/amplifiers/adi,ada4250.yaml
>>>
>>> diff --git a/Documentation/devicetree/bindings/iio/amplifiers/adi,ada4250.yaml b/Documentation/devicetree/bindings/iio/amplifiers/adi,ada4250.yaml
>>> new file mode 100644
>>> index 000000000000..22283ab48903
>>> --- /dev/null
>>> +++ b/Documentation/devicetree/bindings/iio/amplifiers/adi,ada4250.yaml
>>> @@ -0,0 +1,48 @@
>>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>>> +%YAML 1.2
>>> +---
>>> +$id: http://devicetree.org/schemas/iio/amplifiers/adi,ada4250.yaml#
>>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>>> +
>>> +title: ADA4250 Programmable Gain Instrumentation Amplifier
>>> +
>>> +maintainers:
>>> +  - Antoniu Miclaus <antoniu.miclaus@analog.com>
>>> +
>>> +description: |
>>> +  Precision Low Power, 110kHz, 26uA, Programmable Gain Instrumentation Amplifier.
>>> +
>>> +properties:
>>> +  compatible:
>>> +    enum:
>>> +      - adi,ada4250
>>> +
>>> +  reg:
>>> +    maxItems: 1
>>> +
>>> +  avdd-supply: true  
>>
>> Needs a description, not a true.
> 
> For a generic supply where all we really have is a name, I'm not sure
> a description adds anything.  Of course, if there is more info that can be provided
> a description is great to have.

Hm, OK, if the description would be "AVDD supply", then indeed does not
make much sense.

> 
>>
>> As Jonathan said, you should allow spi-max-frequency (so
>> spi-max-frequency: true).
>>
>> No io-channel-cells?
> 
> I'm not sure you'd have a consumer of this type of device, so
> it may not make sense...

OK.


Best regards,
Krzysztof
Jonathan Cameron Feb. 20, 2022, 11:48 a.m. UTC | #4 
On Sun, 20 Feb 2022 11:53:55 +0100
Krzysztof Kozlowski <krzysztof.kozlowski@canonical.com> wrote:

> On 14/02/2022 10:41, Antoniu Miclaus wrote:
> > Add device tree bindings for the ADA4250 driver.  
> 
> Please put the bindings patch as first in the series.
> 
> > 
> > Signed-off-by: Antoniu Miclaus <antoniu.miclaus@analog.com>
> > ---
> >  .../bindings/iio/amplifiers/adi,ada4250.yaml  | 48 +++++++++++++++++++
> >  1 file changed, 48 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/iio/amplifiers/adi,ada4250.yaml
> > 
> > diff --git a/Documentation/devicetree/bindings/iio/amplifiers/adi,ada4250.yaml b/Documentation/devicetree/bindings/iio/amplifiers/adi,ada4250.yaml
> > new file mode 100644
> > index 000000000000..22283ab48903
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/iio/amplifiers/adi,ada4250.yaml
> > @@ -0,0 +1,48 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/iio/amplifiers/adi,ada4250.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: ADA4250 Programmable Gain Instrumentation Amplifier
> > +
> > +maintainers:
> > +  - Antoniu Miclaus <antoniu.miclaus@analog.com>
> > +
> > +description: |
> > +  Precision Low Power, 110kHz, 26uA, Programmable Gain Instrumentation Amplifier.
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - adi,ada4250
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  avdd-supply: true  
> 
> Needs a description, not a true.

For a generic supply where all we really have is a name, I'm not sure
a description adds anything.  Of course, if there is more info that can be provided
a description is great to have.

> 
> As Jonathan said, you should allow spi-max-frequency (so
> spi-max-frequency: true).
> 
> No io-channel-cells?

I'm not sure you'd have a consumer of this type of device, so
it may not make sense...

> 
> > +
> > +  adi,refbuf-enable:
> > +    description:
> > +      Enable internal buffer to drive the reference pin.
> > +    type: boolean
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +  - avdd-supply
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > +  - |
> > +    spi {
> > +      #address-cells = <1>;
> > +      #size-cells = <0>;
> > +      ada4250@0{  
> 
> Generic node name, so "amplifier".
> 
> > +        compatible = "adi,ada4250";
> > +        reg = <0>;
> > +        avdd-supply = <&avdd>;
> > +      };
> > +    };
> > +...  
> 
> 
> Best regards,
> Krzysztof
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iio/amplifiers/adi,ada4250.yaml b/Documentation/devicetree/bindings/iio/amplifiers/adi,ada4250.yaml
new file mode 100644
index 000000000000..22283ab48903
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/amplifiers/adi,ada4250.yaml
@@ -0,0 +1,48 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/amplifiers/adi,ada4250.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: ADA4250 Programmable Gain Instrumentation Amplifier
+
+maintainers:
+  - Antoniu Miclaus <antoniu.miclaus@analog.com>
+
+description: |
+  Precision Low Power, 110kHz, 26uA, Programmable Gain Instrumentation Amplifier.
+
+properties:
+  compatible:
+    enum:
+      - adi,ada4250
+
+  reg:
+    maxItems: 1
+
+  avdd-supply: true
+
+  adi,refbuf-enable:
+    description:
+      Enable internal buffer to drive the reference pin.
+    type: boolean
+
+required:
+  - compatible
+  - reg
+  - avdd-supply
+
+additionalProperties: false
+
+examples:
+  - |
+    spi {
+      #address-cells = <1>;
+      #size-cells = <0>;
+      ada4250@0{
+        compatible = "adi,ada4250";
+        reg = <0>;
+        avdd-supply = <&avdd>;
+      };
+    };
+...