diff mbox series

[v5,1/2] dt-bindings: iio: adc: add max14001

Message ID 20230613093346.60781-1-kimseer.paller@analog.com (mailing list archive)
State Changes Requested
Headers show
Series [v5,1/2] dt-bindings: iio: adc: add max14001 | expand

Commit Message

Kim Seer Paller June 13, 2023, 9:33 a.m. UTC
The MAX14001 is a configurable, isolated 10-bit ADC for multi-range
binary inputs.

Signed-off-by: Kim Seer Paller <kimseer.paller@analog.com>
Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Reported-by: Rob Herring <robh@kernel.org>
Closes: https://lore.kernel.org/all/168663709022.652608.11756645774505315189.robh@kernel.org/
---
V3 -> V5: Added spaces between prefixes in subject. Fixed MAINTAINERS reference.

 .../bindings/iio/adc/adi,max14001.yaml        | 54 +++++++++++++++++++
 MAINTAINERS                                   |  7 +++
 2 files changed, 61 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/adc/adi,max14001.yaml


base-commit: 6f449d52b90fdd927fcf9df0388701de6d5381c6

Comments

Rob Herring June 13, 2023, 10:19 a.m. UTC | #1
On Tue, 13 Jun 2023 17:33:45 +0800, Kim Seer Paller wrote:
> The MAX14001 is a configurable, isolated 10-bit ADC for multi-range
> binary inputs.
> 
> Signed-off-by: Kim Seer Paller <kimseer.paller@analog.com>
> Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
> Reported-by: Rob Herring <robh@kernel.org>
> Closes: https://lore.kernel.org/all/168663709022.652608.11756645774505315189.robh@kernel.org/
> ---
> V3 -> V5: Added spaces between prefixes in subject. Fixed MAINTAINERS reference.
> 
>  .../bindings/iio/adc/adi,max14001.yaml        | 54 +++++++++++++++++++
>  MAINTAINERS                                   |  7 +++
>  2 files changed, 61 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/adc/adi,max14001.yaml
> 

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:

dtschema/dtc warnings/errors:
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/pinctrl/qcom,pmic-mpp.yaml: $defs:qcom-pmic-mpp-state:properties:qcom,paired: [{'description': 'Indicates that the pin should be operating in paired mode.'}] is not of type 'object', 'boolean'
	from schema $id: http://devicetree.org/meta-schemas/core.yaml#

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20230613093346.60781-1-kimseer.paller@analog.com

The base for the series is generally the latest rc1. A different dependency
should be noted in *this* patch.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit after running the above command yourself. Note
that DT_SCHEMA_FILES can be set to your schema file to speed up checking
your schema. However, it must be unset to test all examples with your schema.
Kim Seer Paller June 13, 2023, 2:07 p.m. UTC | #2
> -----Original Message-----
> From: Rob Herring <robh@kernel.org>
> Sent: Tuesday, June 13, 2023 6:19 PM
> To: Paller, Kim Seer <KimSeer.Paller@analog.com>
> Cc: devicetree@vger.kernel.org; Krzysztof Kozlowski
> <krzysztof.kozlowski@linaro.org>; lgirdwood@gmail.com; broonie@kernel.org;
> andy.shevchenko@gmail.com; linux-kernel@vger.kernel.org;
> conor+dt@kernel.org; Hennerich, Michael <Michael.Hennerich@analog.com>;
> robh+dt@kernel.org; krzysztof.kozlowski+dt@linaro.org; lars@metafoo.de;
> jic23@kernel.org; linux-iio@vger.kernel.org
> Subject: Re: [PATCH v5 1/2] dt-bindings: iio: adc: add max14001
> 
> [External]
> 
> 
> On Tue, 13 Jun 2023 17:33:45 +0800, Kim Seer Paller wrote:
> > The MAX14001 is a configurable, isolated 10-bit ADC for multi-range
> > binary inputs.
> >
> > Signed-off-by: Kim Seer Paller <kimseer.paller@analog.com>
> > Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
> > Reported-by: Rob Herring <robh@kernel.org>
> > Closes:
> > https://urldefense.com/v3/__https://lore.kernel.org/all/168663709022.6
> >
> 52608.11756645774505315189.robh@kernel.org/__;!!A3Ni8CS0y2Y!5MOlRh
> mYJL
> >
> qPmhR7QmgutQNBKIuJTk_FlMbFGnFd4R9dVxnXWk8rY0woqzhv5YcF58DvBLTrc
> xVK5KdS
> > $
> > ---
> > V3 -> V5: Added spaces between prefixes in subject. Fixed MAINTAINERS
> reference.
> >
> >  .../bindings/iio/adc/adi,max14001.yaml        | 54 +++++++++++++++++++
> >  MAINTAINERS                                   |  7 +++
> >  2 files changed, 61 insertions(+)
> >  create mode 100644
> > Documentation/devicetree/bindings/iio/adc/adi,max14001.yaml
> >
> 
> My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
> on your patch (DT_CHECKER_FLAGS is new in v5.13):
> 
> yamllint warnings/errors:
> 
> dtschema/dtc warnings/errors:
> /builds/robherring/dt-review-
> ci/linux/Documentation/devicetree/bindings/pinctrl/qcom,pmic-mpp.yaml:
> $defs:qcom-pmic-mpp-state:properties:qcom,paired: [{'description': 'Indicates
> that the pin should be operating in paired mode.'}] is not of type 'object',
> 'boolean'
> 	from schema $id:
> https://urldefense.com/v3/__http://devicetree.org/meta-
> schemas/core.yaml*__;Iw!!A3Ni8CS0y2Y!5MOlRhmYJLqPmhR7QmgutQNBKIuJ
> Tk_FlMbFGnFd4R9dVxnXWk8rY0woqzhv5YcF58DvBLTrc0FLIB-v$
> 
> doc reference errors (make refcheckdocs):

Could the doc reference error also be ignored? I cannot reproduce the same error on my side.

Best regards,
Kim
Conor Dooley June 13, 2023, 6:07 p.m. UTC | #3
On Tue, Jun 13, 2023 at 02:07:39PM +0000, Paller, Kim Seer wrote:
> > From: Rob Herring <robh@kernel.org>
> > On Tue, 13 Jun 2023 17:33:45 +0800, Kim Seer Paller wrote:

> > >  .../bindings/iio/adc/adi,max14001.yaml        | 54 +++++++++++++++++++

> > 
> > My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
> > on your patch (DT_CHECKER_FLAGS is new in v5.13):
> > 
> > yamllint warnings/errors:
> > 
> > dtschema/dtc warnings/errors:
> > /builds/robherring/dt-review-
> > ci/linux/Documentation/devicetree/bindings/pinctrl/qcom,pmic-mpp.yaml:
> > $defs:qcom-pmic-mpp-state:properties:qcom,paired: [{'description': 'Indicates
> > that the pin should be operating in paired mode.'}] is not of type 'object',
> > 'boolean'
> > 	from schema $id:
> > https://urldefense.com/v3/__http://devicetree.org/meta-
> > schemas/core.yaml*__;Iw!!A3Ni8CS0y2Y!5MOlRhmYJLqPmhR7QmgutQNBKIuJ
> > Tk_FlMbFGnFd4R9dVxnXWk8rY0woqzhv5YcF58DvBLTrc0FLIB-v$
> > 
> > doc reference errors (make refcheckdocs):
> 
> Could the doc reference error also be ignored? I cannot reproduce the same error on my side.

The whole report from the bot looks unrelated & ignorable.

Cheers,
Conor.
Krzysztof Kozlowski June 13, 2023, 6:16 p.m. UTC | #4
On 13/06/2023 11:33, Kim Seer Paller wrote:
> The MAX14001 is a configurable, isolated 10-bit ADC for multi-range
> binary inputs.
> 
> Signed-off-by: Kim Seer Paller <kimseer.paller@analog.com>
> Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
> Reported-by: Rob Herring <robh@kernel.org>
> Closes: https://lore.kernel.org/all/168663709022.652608.11756645774505315189.robh@kernel.org/

Nothing to report nor to close here. Drop the tags.

> ---
> V3 -> V5: Added spaces between prefixes in subject. Fixed MAINTAINERS reference.
> 



Best regards,
Krzysztof
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iio/adc/adi,max14001.yaml b/Documentation/devicetree/bindings/iio/adc/adi,max14001.yaml
new file mode 100644
index 000000000000..9d03c611fca3
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/adc/adi,max14001.yaml
@@ -0,0 +1,54 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+# Copyright 2023 Analog Devices Inc.
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/adc/adi,max14001.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Analog Devices MAX14001 ADC
+
+maintainers:
+  - Kim Seer Paller <kimseer.paller@analog.com>
+
+description: |
+    Single channel 10 bit ADC with SPI interface. Datasheet
+    can be found here:
+      https://www.analog.com/media/en/technical-documentation/data-sheets/MAX14001-MAX14002.pdf
+
+properties:
+  compatible:
+    enum:
+      - adi,max14001
+
+  reg:
+    maxItems: 1
+
+  spi-max-frequency:
+    maximum: 5000000
+
+  vref-supply:
+    description: Voltage reference to establish input scaling.
+
+required:
+  - compatible
+  - reg
+
+allOf:
+  - $ref: /schemas/spi/spi-peripheral-props.yaml#
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    spi {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        adc@0 {
+            compatible = "adi,max14001";
+            reg = <0>;
+            spi-max-frequency = <5000000>;
+            vref-supply = <&vref_reg>;
+        };
+    };
+...
diff --git a/MAINTAINERS b/MAINTAINERS
index f794002a192e..dcea2c31f920 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -12670,6 +12670,13 @@  S:	Maintained
 F:	Documentation/devicetree/bindings/sound/max9860.txt
 F:	sound/soc/codecs/max9860.*
 
+MAX14001 IIO ADC DRIVER
+M:	Kim Seer Paller <kimseer.paller@analog.com>
+L:	linux-iio@vger.kernel.org
+S:	Supported
+W:	https://ez.analog.com/linux-software-drivers
+F:	Documentation/devicetree/bindings/iio/adc/adi,max14001.yaml
+
 MAXBOTIX ULTRASONIC RANGER IIO DRIVER
 M:	Andreas Klinger <ak@it-klinger.de>
 L:	linux-iio@vger.kernel.org