Skip to contentSkip to conversation

Maxim MAX1241 driver

PATCH Superseded Alexandru Lazar 5 participants 14 messages Mar 20, 2020 – Mar 30, 2020

Subsystems (2)

v4 of 7 Superseded Latest is v7 →

lore
Share & tools
lore
#0 lore raw

v4 cover Maxim MAX1241 driver

Hello again,

Here's version 4 of a patch series which adds support for the Maxim MAX1241, a 12-bit, single-channel, SPI-connected ADC.

Changelog so far:

v4:

* Dropped explicit documentation of SPI reg property
* Reordered patch series so that dt bindings come first

v3:

* Fixed silly copy-paste error in Kconfig description

v2:

* Removed useeless header includes
* Dropped needlessly verbose stuff in _read and _probe functions
* Dropped useless GPL notice
* Lowered log level of shdn pin status in probe function, now it's dev_dbg
* Added proper error checking for the GPIO shutdown pin
* remove now always returns zero (man, I've been wrong about this for *years* now...)
* Added regulator disable action, cleanup is now handled via devm
* Drop delay_usecs, use delay.value, delay.unit
* Drop config_of, of_match_ptr call
* Dropped IIO_BUFFER, IIO_TRIGGERED_BUFFER dependencies, set SPI_MASTER as dependency, fix indenting.
* DT binding: use correct id, add reg description (looks pretty standard), dropped spi-max-frequency, fixed dt_binding_check complaints (oops!)

Apologies for the last botched message -- my machine died at the wrongest possible time.

All the best,
Alex

Alexandru Lazar (2):
dt-bindings: iio: adc: Add MAX1241 device tree bindings in
documentation
iio: adc: Add MAX1241 driver

 .../bindings/iio/adc/maxim,max1241.yaml       |  61 ++++++
 drivers/iio/adc/Kconfig                       |  10 +
 drivers/iio/adc/Makefile                      |   1 +
 drivers/iio/adc/max1241.c                     | 206 ++++++++++++++++++
 4 files changed, 278 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml
 create mode 100644 drivers/iio/adc/max1241.c
Signature · 1 line
2.25.2
#1 lore raw

PATCH v4 1/2 dt-bindings: iio: adc: Add MAX1241 device tree bindings in documentation

Add device-tree bindings documentation for the MAX1241 device driver.

---
 .../bindings/iio/adc/maxim,max1241.yaml       | 61 +++++++++++++++++++
 1 file changed, 61 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml
Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml new file +61 -0
new file mode 100644
index 000000000000..de41d422ce3b
@@ -0,0 +1,61 @@
+# SPDX-License-Identifier: GPL-2.0
+# Copyright 2020 Ioan-Alexandru Lazar
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/adc/maxim,max1241.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Maxim MAX1241 12-bit, single-channel analog to digital converter
+
+maintainers:
+  - Ioan-Alexandru Lazar <[email protected]>
+
+description: |
+  Bindings for the max1241 12-bit, single-channel ADC device. This
+  driver supports voltage reading and can optionally be configured for
+  power-down mode operation. The datasheet can be found at:
+    https://datasheets.maximintegrated.com/en/ds/MAX1240-MAX1241.pdf
+
+properties:
+  compatible:
+    enum:
+      - maxim,max1241
+
+  reg:
+    maxItems: 1
+
+  vref-supply:
+    description:
+      Device tree identifier of the regulator that provides the external
+      reference voltage.
+    maxItems: 1
+
+  shdn-gpios:
+    description:
+      GPIO spec for the GPIO pin connected to the ADC's /SHDN pin. If
+      specified, the /SHDN pin will be asserted between conversions,
+      thus enabling power-down mode.
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - vref-supply
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    spi0 {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+        adc@0 {
+            compatible = "maxim,max1241";
+            reg = <0>;
+            vref-supply = <&vdd_3v3_reg>;
+            spi-max-frequency = <1000000>;
+            shdn-gpios = <&gpio 26 1>;
+        };
+    };
+
+
Signature · 1 line
2.25.2
maintainer
#2 lore raw

Re: [PATCH v4 1/2] dt-bindings: iio: adc: Add MAX1241 device tree bindings in documentation

Quoted 3 lines · On Fri, 20 Mar 2020 17:01:14 +0200 Alexandru Lazar <[email protected]> wrote:

Add device-tree bindings documentation for the MAX1241 device driver.

Please consider also adding the vdd-supply.
It's not really required, but if you don't add it from the start chances are high that at some point someone else will need to add it.

One trivial thing inline. Otherwise looks good to me.

Quoted 16 lines
---
 .../bindings/iio/adc/maxim,max1241.yaml       | 61 +++++++++++++++++++
 1 file changed, 61 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml
Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml new file +5 -0
new file mode 100644
index 000000000000..de41d422ce3b
@@ -0,0 +1,61 @@
+# SPDX-License-Identifier: GPL-2.0
+# Copyright 2020 Ioan-Alexandru Lazar
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/adc/maxim,max1241.yaml#

Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml line 15

Quoted 10 lines
Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml new file +10 -0
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Maxim MAX1241 12-bit, single-channel analog to digital converter
+
+maintainers:
+  - Ioan-Alexandru Lazar <[email protected]>
+
+description: |
+  Bindings for the max1241 12-bit, single-channel ADC device. This
+  driver supports voltage reading and can optionally be configured for

Driver shouldn't be mentioned in the binding. It's a description of the hardware only.

Quoted 46 lines
Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml new file +46 -0
+  power-down mode operation. The datasheet can be found at:
+    https://datasheets.maximintegrated.com/en/ds/MAX1240-MAX1241.pdf
+
+properties:
+  compatible:
+    enum:
+      - maxim,max1241
+
+  reg:
+    maxItems: 1
+
+  vref-supply:
+    description:
+      Device tree identifier of the regulator that provides the external
+      reference voltage.
+    maxItems: 1
+
+  shdn-gpios:
+    description:
+      GPIO spec for the GPIO pin connected to the ADC's /SHDN pin. If
+      specified, the /SHDN pin will be asserted between conversions,
+      thus enabling power-down mode.
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - vref-supply
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    spi0 {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+        adc@0 {
+            compatible = "maxim,max1241";
+            reg = <0>;
+            vref-supply = <&vdd_3v3_reg>;
+            spi-max-frequency = <1000000>;
+            shdn-gpios = <&gpio 26 1>;
+        };
+    };
+
+
#3 lore raw

Re: [PATCH v4 1/2] dt-bindings: iio: adc: Add MAX1241 device tree bindings in documentation

Hi Jonathan,

Quoted 4 lines

Please consider also adding the vdd-supply.
It's not really required, but if you don't add it from the start chances are high that at some point someone else will need to add it.

Sorry if I'm missing something obvious here -- what vdd-supply is that? Are you thinking of the regulator used for the ADC's reference voltage? That's already there (vref-supply).

Or did you mean I should add a definition for the regulator output used for the device's Vdd input (i.e. the positive supply voltage)? Needless to say, I'm happy to add it if you think it's a good idea. It's just I don't think I've seen it in other drivers (except maybe ad7192?) -- so I figured I'd ask before sending a botched v5.

Best regards,
Alex

Quoted 80 lines

One trivial thing inline. Otherwise looks good to me.

Quoted 16 lines
---
 .../bindings/iio/adc/maxim,max1241.yaml       | 61 +++++++++++++++++++
 1 file changed, 61 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml
Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml new file +5 -0
new file mode 100644
index 000000000000..de41d422ce3b
@@ -0,0 +1,61 @@
+# SPDX-License-Identifier: GPL-2.0
+# Copyright 2020 Ioan-Alexandru Lazar
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/adc/maxim,max1241.yaml#

Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml line 15

Quoted 10 lines
Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml new file +10 -0
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Maxim MAX1241 12-bit, single-channel analog to digital converter
+
+maintainers:
+  - Ioan-Alexandru Lazar <[email protected]>
+
+description: |
+  Bindings for the max1241 12-bit, single-channel ADC device. This
+  driver supports voltage reading and can optionally be configured for

Driver shouldn't be mentioned in the binding. It's a description of the hardware only.

Quoted 46 lines
Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml new file +46 -0
+  power-down mode operation. The datasheet can be found at:
+    https://datasheets.maximintegrated.com/en/ds/MAX1240-MAX1241.pdf
+
+properties:
+  compatible:
+    enum:
+      - maxim,max1241
+
+  reg:
+    maxItems: 1
+
+  vref-supply:
+    description:
+      Device tree identifier of the regulator that provides the external
+      reference voltage.
+    maxItems: 1
+
+  shdn-gpios:
+    description:
+      GPIO spec for the GPIO pin connected to the ADC's /SHDN pin. If
+      specified, the /SHDN pin will be asserted between conversions,
+      thus enabling power-down mode.
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - vref-supply
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    spi0 {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+        adc@0 {
+            compatible = "maxim,max1241";
+            reg = <0>;
+            vref-supply = <&vdd_3v3_reg>;
+            spi-max-frequency = <1000000>;
+            shdn-gpios = <&gpio 26 1>;
+        };
+    };
+
+
#4 lore raw

Re: [PATCH v4 1/2] dt-bindings: iio: adc: Add MAX1241 device tree bindings in documentation

Quoted 11 lines · Alexandru Lazar

Hi Jonathan,

Quoted 4 lines

Please consider also adding the vdd-supply.
It's not really required, but if you don't add it from the start chances are high that at some point someone else will need to add it.

Sorry if I'm missing something obvious here -- what vdd-supply is that? Are you thinking of the regulator used for the ADC's reference voltage? That's already there (vref-supply).

Quoted 6 lines

Or did you mean I should add a definition for the regulator output used for the device's Vdd input (i.e. the positive supply voltage)? Needless to say, I'm happy to add it if you think it's a good idea. It's just I don't think I've seen it in other drivers (except maybe ad7192?) -- so I figured I'd ask before sending a botched v5.

Yep.
Jonathan refers to Vdd input/pin [on the chip] which is different from Vref [REF pin].
Not all drivers define Vdd.
Some call it AVdd.

You can check via: git grep -i vdd | cut -d: -f1 | sort | uniq -c in the drivers/iio folder

It's an idea to add it, and that can give control to the driver to power-up the ADC, by defining a regulator [vdd-supply] in the device-tree.

Maybe it could be interesting to move this to the IIO core as an option-flag. [But that's another discussion]

Quoted 83 lines

Best regards,
Alex

Quoted 80 lines

One trivial thing inline. Otherwise looks good to me.

Quoted 18 lines
---
 .../bindings/iio/adc/maxim,max1241.yaml       | 61 +++++++++++++++++++
 1 file changed, 61 insertions(+)
 create mode 100644

Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml

Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml new file +5 -0
new file mode 100644
index 000000000000..de41d422ce3b
@@ -0,0 +1,61 @@
+# SPDX-License-Identifier: GPL-2.0
+# Copyright 2020 Ioan-Alexandru Lazar
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/adc/maxim,max1241.yaml#

Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml line 15

Quoted 10 lines
Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml new file +10 -0
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Maxim MAX1241 12-bit, single-channel analog to digital converter
+
+maintainers:
+  - Ioan-Alexandru Lazar <[email protected]>
+
+description: |
+  Bindings for the max1241 12-bit, single-channel ADC device. This
+  driver supports voltage reading and can optionally be configured for

Driver shouldn't be mentioned in the binding. It's a description of the hardware only.

Quoted 46 lines
Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml new file +46 -0
+  power-down mode operation. The datasheet can be found at:
+    https://datasheets.maximintegrated.com/en/ds/MAX1240-MAX1241.pdf
+
+properties:
+  compatible:
+    enum:
+      - maxim,max1241
+
+  reg:
+    maxItems: 1
+
+  vref-supply:
+    description:
+      Device tree identifier of the regulator that provides the external
+      reference voltage.
+    maxItems: 1
+
+  shdn-gpios:
+    description:
+      GPIO spec for the GPIO pin connected to the ADC's /SHDN pin. If
+      specified, the /SHDN pin will be asserted between conversions,
+      thus enabling power-down mode.
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - vref-supply
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    spi0 {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+        adc@0 {
+            compatible = "maxim,max1241";
+            reg = <0>;
+            vref-supply = <&vdd_3v3_reg>;
+            spi-max-frequency = <1000000>;
+            shdn-gpios = <&gpio 26 1>;
+        };
+    };
+
+
#5 lore raw

Re: [PATCH v4 1/2] dt-bindings: iio: adc: Add MAX1241 device tree bindings in documentation

Quoted 10 lines

Yep.
Jonathan refers to Vdd input/pin [on the chip] which is different from Vref [REF pin].
Not all drivers define Vdd.
Some call it AVdd.

[...]

It's an idea to add it, and that can give control to the driver to power-up the ADC, by defining a regulator [vdd-supply] in the device-tree.

Hmm... I don't know how useful this would be for the 124x family (I doubt anyone who needs one of these will power it from its own, independent supply), but it's a pretty harmless change. I can't think of any reason to say no :-).

Thanks,
Alex

maintainer
#6 lore raw

Re: [PATCH v4 1/2] dt-bindings: iio: adc: Add MAX1241 device tree bindings in documentation

Quoted 6 lines · On Sun, 22 Mar 2020 11:53:17 +0200 Alexandru Lazar <[email protected]> wrote:
Quoted 6 lines

Yep.
Jonathan refers to Vdd input/pin [on the chip] which is different from Vref [REF pin].
Not all drivers define Vdd.
Some call it AVdd.

Quoted 8 lines
Quoted 4 lines

[...]

It's an idea to add it, and that can give control to the driver to power-up the ADC, by defining a regulator [vdd-supply] in the device-tree.

Hmm... I don't know how useful this would be for the 124x family (I doubt anyone who needs one of these will power it from its own, independent supply),

You'd be surprised how often this gets added to drivers precisely because people will put it on a controllable supply. It may well not have it's own supply but it may share one with a bunch of other external chips and all of them need to use the regulator framework controls to make sure it's only disabled when they are all suspended etc.

See the number of times Linus Walleij has added this for various sensors and ADCs because he has boards where the control is needed.

Jonathan

Quoted 5 lines

but it's a pretty harmless change. I can't think of any reason to say no :-).

Thanks,
Alex

#7 lore raw

Re: [PATCH v4 1/2] dt-bindings: iio: adc: Add MAX1241 device tree bindings in documentation

Quoted 5 lines

You'd be surprised how often this gets added to drivers precisely because people will put it on a controllable supply. It may well not have it's own supply but it may share one with a bunch of other external chips and all of them need to use the regulator framework controls to make sure it's only disabled when they are all suspended etc.

I figured it might be something like this :-). I've added the vdd-supply binding in v5.

If this isn't something that can be easily handled in the core, do you think we can document it somewhere as a convention/common idiom? (Assuming it's not already documented, of course). It seems like it's something that all IIO devices would need. I can do the writing part.

Thanks,
Alex

maintainer
#8 lore raw

Re: [PATCH v4 1/2] dt-bindings: iio: adc: Add MAX1241 device tree bindings in documentation

Quoted 6 lines · On Sun, 22 Mar 2020 18:06:04 +0200 Alexandru Lazar <[email protected]> wrote:
Quoted 5 lines

You'd be surprised how often this gets added to drivers precisely because people will put it on a controllable supply. It may well not have it's own supply but it may share one with a bunch of other external chips and all of them need to use the regulator framework controls to make sure it's only disabled when they are all suspended etc.

Quoted 7 lines

I figured it might be something like this :-). I've added the vdd-supply binding in v5.

If this isn't something that can be easily handled in the core, do you think we can document it somewhere as a convention/common idiom? (Assuming it's not already documented, of course). It seems like it's something that all IIO devices would need. I can do the writing part.

Hmm. We could do with a sort of 'things you'd normally find in a driver' document. We don't have such a document, but interesting to think about what would be in it... Perhaps a 'best practice' document would be a better way of putting it. I don't really want to see a huge number of patches adding regulators to drivers that don't have them already for example. Clearly no one needed them yet :)

If you want to take a stab at such a document that would be great.

Jonathan

Quoted 3 lines

Thanks,
Alex

maintainer
#9 lore raw

Re: [PATCH v4 1/2] dt-bindings: iio: adc: Add MAX1241 device tree bindings in documentation

In reply to Ardelean, Alexandru
Quoted 25 lines · Alexandru
Quoted 11 lines · Alexandru Lazar

Hi Jonathan,

Quoted 4 lines

Please consider also adding the vdd-supply.
It's not really required, but if you don't add it from the start chances are high that at some point someone else will need to add it.

Sorry if I'm missing something obvious here -- what vdd-supply is that? Are you thinking of the regulator used for the ADC's reference voltage? That's already there (vref-supply).

Quoted 6 lines

Or did you mean I should add a definition for the regulator output used for the device's Vdd input (i.e. the positive supply voltage)? Needless to say, I'm happy to add it if you think it's a good idea. It's just I don't think I've seen it in other drivers (except maybe ad7192?) -- so I figured I'd ask before sending a botched v5.

Yep.
Jonathan refers to Vdd input/pin [on the chip] which is different from Vref [REF pin].
Not all drivers define Vdd.
Some call it AVdd.

Quoted 8 lines

You can check via: git grep -i vdd | cut -d: -f1 | sort | uniq -c in the drivers/iio folder

It's an idea to add it, and that can give control to the driver to power-up the ADC, by defining a regulator [vdd-supply] in the device-tree.

Maybe it could be interesting to move this to the IIO core as an option-flag. [But that's another discussion]

Can't easily move it to the core because how you actually handle it is very much driver dependent. A devices that has state will keep it on most of the time, but other drivers will handle it in runtime pm if the device starts up quickly enough.

We want this to be visible in individual drivers, even if it would be less code perhaps in the core.

Jonathan

Quoted 84 lines
Quoted 84 lines

Best regards,
Alex

Quoted 80 lines

One trivial thing inline. Otherwise looks good to me.

Quoted 18 lines
---
 .../bindings/iio/adc/maxim,max1241.yaml       | 61 +++++++++++++++++++
 1 file changed, 61 insertions(+)
 create mode 100644

Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml

Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml new file +5 -0
new file mode 100644
index 000000000000..de41d422ce3b
@@ -0,0 +1,61 @@
+# SPDX-License-Identifier: GPL-2.0
+# Copyright 2020 Ioan-Alexandru Lazar
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/adc/maxim,max1241.yaml#

Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml line 15

Quoted 10 lines
Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml new file +10 -0
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Maxim MAX1241 12-bit, single-channel analog to digital converter
+
+maintainers:
+  - Ioan-Alexandru Lazar <[email protected]>
+
+description: |
+  Bindings for the max1241 12-bit, single-channel ADC device. This
+  driver supports voltage reading and can optionally be configured for  

Driver shouldn't be mentioned in the binding. It's a description of the hardware only.

Quoted 46 lines
Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml new file +46 -0
+  power-down mode operation. The datasheet can be found at:
+    https://datasheets.maximintegrated.com/en/ds/MAX1240-MAX1241.pdf
+
+properties:
+  compatible:
+    enum:
+      - maxim,max1241
+
+  reg:
+    maxItems: 1
+
+  vref-supply:
+    description:
+      Device tree identifier of the regulator that provides the external
+      reference voltage.
+    maxItems: 1
+
+  shdn-gpios:
+    description:
+      GPIO spec for the GPIO pin connected to the ADC's /SHDN pin. If
+      specified, the /SHDN pin will be asserted between conversions,
+      thus enabling power-down mode.
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - vref-supply
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    spi0 {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+        adc@0 {
+            compatible = "maxim,max1241";
+            reg = <0>;
+            vref-supply = <&vdd_3v3_reg>;
+            spi-max-frequency = <1000000>;
+            shdn-gpios = <&gpio 26 1>;
+        };
+    };
+
+  
maintainer
#10 lore raw

Re: [PATCH v4 1/2] dt-bindings: iio: adc: Add MAX1241 device tree bindings in documentation

In reply to Alexandru Lazar
Quoted 14 lines · Alexandru Lazar

Add device-tree bindings documentation for the MAX1241 device driver.

---
 .../bindings/iio/adc/maxim,max1241.yaml       | 61 +++++++++++++++++++
 1 file changed, 61 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml
Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml new file +0 -0
new file mode 100644
index 000000000000..de41d422ce3b

Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml line 1

Quoted 1 line
Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml new file +1 -0
@@ -0,0 +1,61 @@
+# SPDX-License-Identifier: GPL-2.0

Dual license new bindings please:

(GPL-2.0-only OR BSD-2-Clause)

Quoted 20 lines
Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml new file +20 -0
+# Copyright 2020 Ioan-Alexandru Lazar
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/adc/maxim,max1241.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Maxim MAX1241 12-bit, single-channel analog to digital converter
+
+maintainers:
+  - Ioan-Alexandru Lazar <[email protected]>
+
+description: |
+  Bindings for the max1241 12-bit, single-channel ADC device. This
+  driver supports voltage reading and can optionally be configured for
+  power-down mode operation. The datasheet can be found at:
+    https://datasheets.maximintegrated.com/en/ds/MAX1240-MAX1241.pdf
+
+properties:
+  compatible:
+    enum:

Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml line 31

Quoted 10 lines
Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml new file +10 -0
+      - maxim,max1241
+
+  reg:
+    maxItems: 1
+
+  vref-supply:
+    description:
+      Device tree identifier of the regulator that provides the external
+      reference voltage.
+    maxItems: 1

Drop this. Supplies are always 1 item.

Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml line 33

Quoted 2 lines
Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml new file +2 -0
+
+  shdn-gpios:

shutdown-gpios is the semi standard name.

Quoted 5 lines
Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml new file +5 -0
+    description:
+      GPIO spec for the GPIO pin connected to the ADC's /SHDN pin. If
+      specified, the /SHDN pin will be asserted between conversions,
+      thus enabling power-down mode.
+    maxItems: 1

Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml line 48

Quoted 10 lines
Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml new file +10 -0
+
+required:
+  - compatible
+  - reg
+  - vref-supply
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    spi0 {

Just 'spi'

Quoted 16 lines
Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml new file +13 -0
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+        adc@0 {
+            compatible = "maxim,max1241";
+            reg = <0>;
+            vref-supply = <&vdd_3v3_reg>;
+            spi-max-frequency = <1000000>;
+            shdn-gpios = <&gpio 26 1>;
+        };
+    };
+
+
Signature · 1 line
2.25.2
#11 lore raw

PATCH v4 2/2 iio: adc: Add MAX1241 driver

In reply to Alexandru Lazar

Add driver for the Maxim MAX1241 12-bit, single-channel ADC. The driver includes support for this device's low-power operation mode.

---
 drivers/iio/adc/Kconfig   |  10 ++
 drivers/iio/adc/Makefile  |   1 +
 drivers/iio/adc/max1241.c | 206 ++++++++++++++++++++++++++++++++++++++
 3 files changed, 217 insertions(+)
 create mode 100644 drivers/iio/adc/max1241.c
drivers/iio/adc/Kconfig +10 -0
index 5d8540b7b427..55f6462cd93f 100644
@@ -566,6 +566,16 @@ config MAX1118
 	  To compile this driver as a module, choose M here: the module will be
 	  called max1118.
 
+config MAX1241
+	tristate "Maxim max1241 ADC driver"
+	depends on SPI_MASTER
+	help
+	  Say yes here to build support for Maxim max1241 12-bit, single-channel
+	  ADC.
+
+	  To compile this driver as a module, choose M here: the module will be
+	  called max1241.
+
 config MAX1363
 	tristate "Maxim max1363 ADC driver"
 	depends on I2C
drivers/iio/adc/Makefile +1 -0
index a1f1fbec0f87..37d6f17559dc 100644
@@ -54,6 +54,7 @@ obj-$(CONFIG_LTC2497) += ltc2497.o
 obj-$(CONFIG_MAX1027) += max1027.o
 obj-$(CONFIG_MAX11100) += max11100.o
 obj-$(CONFIG_MAX1118) += max1118.o
+obj-$(CONFIG_MAX1241) += max1241.o
 obj-$(CONFIG_MAX1363) += max1363.o
 obj-$(CONFIG_MAX9611) += max9611.o
 obj-$(CONFIG_MCP320X) += mcp320x.o
drivers/iio/adc/max1241.c new file +206 -0

206 lines not on this page · raw message

Signature · 1 line
2.25.2
maintainer
#12 lore raw

Re: [PATCH v4 2/2] iio: adc: Add MAX1241 driver

Quoted 5 lines · On Fri, 20 Mar 2020 17:01:15 +0200 Alexandru Lazar <[email protected]> wrote:

Add driver for the Maxim MAX1241 12-bit, single-channel ADC. The driver includes support for this device's low-power operation mode.

Few minor things inline, but looks good in general.

Quoted 46 lines
---
 drivers/iio/adc/Kconfig   |  10 ++
 drivers/iio/adc/Makefile  |   1 +
 drivers/iio/adc/max1241.c | 206 ++++++++++++++++++++++++++++++++++++++
 3 files changed, 217 insertions(+)
 create mode 100644 drivers/iio/adc/max1241.c
drivers/iio/adc/Kconfig +10 -0
index 5d8540b7b427..55f6462cd93f 100644
@@ -566,6 +566,16 @@ config MAX1118
 	  To compile this driver as a module, choose M here: the module will be
 	  called max1118.
 
+config MAX1241
+	tristate "Maxim max1241 ADC driver"
+	depends on SPI_MASTER
+	help
+	  Say yes here to build support for Maxim max1241 12-bit, single-channel
+	  ADC.
+
+	  To compile this driver as a module, choose M here: the module will be
+	  called max1241.
+
 config MAX1363
 	tristate "Maxim max1363 ADC driver"
 	depends on I2C
drivers/iio/adc/Makefile +1 -0
index a1f1fbec0f87..37d6f17559dc 100644
@@ -54,6 +54,7 @@ obj-$(CONFIG_LTC2497) += ltc2497.o
 obj-$(CONFIG_MAX1027) += max1027.o
 obj-$(CONFIG_MAX11100) += max11100.o
 obj-$(CONFIG_MAX1118) += max1118.o
+obj-$(CONFIG_MAX1241) += max1241.o
 obj-$(CONFIG_MAX1363) += max1363.o
 obj-$(CONFIG_MAX9611) += max9611.o
 obj-$(CONFIG_MCP320X) += mcp320x.o
drivers/iio/adc/max1241.c new file +0 -0
new file mode 100644
index 000000000000..0278510ec346

drivers/iio/adc/max1241.c line 8

Quoted 8 lines
drivers/iio/adc/max1241.c new file +8 -0
@@ -0,0 +1,206 @@
+// SPDX-License-Identifier: GPL-2.0-only
+/*
+ * MAX1241 low-power, 12-bit serial ADC
+ *
+ * Datasheet: https://datasheets.maximintegrated.com/en/ds/MAX1240-MAX1241.pdf
+ */
+
+#include <linux/regulator/consumer.h>

Nitpick; Tidy up ordering of headers. If no other reason to have a particular order go with alphabetical.

Quoted 25 lines
drivers/iio/adc/max1241.c new file +25 -0
+#include <linux/delay.h>
+#include <linux/gpio/consumer.h>
+#include <linux/iio/iio.h>
+#include <linux/module.h>
+#include <linux/spi/spi.h>
+
+#define MAX1241_VAL_MASK 0xFFF
+#define MAX1241_SHDN_DELAY_USEC 4
+
+enum max1241_id {
+	max1241,
+};
+
+struct max1241 {
+	struct spi_device *spi;
+	struct mutex lock;
+	struct regulator *reg;
+	struct gpio_desc *shdn;
+
+	__be16 data ____cacheline_aligned;
+};
+
+static const struct iio_chan_spec max1241_channels[] = {
+	{
+		.type = IIO_VOLTAGE,

drivers/iio/adc/max1241.c line 43

Quoted 10 lines
drivers/iio/adc/max1241.c new file +10 -0
+		.indexed = 1,
+		.channel = 0,
+		.info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
+				BIT(IIO_CHAN_INFO_SCALE),
+		.scan_index = 0,
+		.scan_type = {
+			.sign = 'u',
+			.realbits = 12,
+			.storagebits = 16,
+		},

No need to specify scan_index or scan_type unless the driver supports buffered modes. Nothing will use them until then.

Quoted 81 lines
drivers/iio/adc/max1241.c new file +81 -0
+	},
+};
+
+static int max1241_read(struct max1241 *adc)
+{
+	struct spi_transfer xfers[] = {
+		/*
+		 * Begin conversion by bringing /CS low for at least
+		 * tconv us.
+		 */
+		{
+			.len = 0,
+			.delay.value = 8,
+			.delay.unit = SPI_DELAY_UNIT_USECS,
+		},
+		/*
+		 * Then read two bytes of data in our RX buffer.
+		 */
+		{
+			.rx_buf = &adc->data,
+			.len = 2,
+		},
+	};
+
+	return spi_sync_transfer(adc->spi, xfers, ARRAY_SIZE(xfers));
+}
+
+static int max1241_read_raw(struct iio_dev *indio_dev,
+			struct iio_chan_spec const *chan,
+			int *val, int *val2, long mask)
+{
+	int ret, vref_uV;
+	struct max1241 *adc = iio_priv(indio_dev);
+
+	switch (mask) {
+	case IIO_CHAN_INFO_RAW:
+		mutex_lock(&adc->lock);
+
+		if (adc->shdn) {
+			gpiod_set_value(adc->shdn, 0);
+			udelay(MAX1241_SHDN_DELAY_USEC);
+		}
+
+		ret = max1241_read(adc);
+
+		if (adc->shdn)
+			gpiod_set_value(adc->shdn, 1);
+
+		if (ret) {
+			mutex_unlock(&adc->lock);
+			return ret;
+		}
+
+		*val = (be16_to_cpu(adc->data) >> 3) & MAX1241_VAL_MASK;
+
+		mutex_unlock(&adc->lock);
+		return IIO_VAL_INT;
+	case IIO_CHAN_INFO_SCALE:
+		vref_uV = regulator_get_voltage(adc->reg);
+
+		if (vref_uV < 0)
+			return vref_uV;
+
+		*val = vref_uV / 1000;
+		*val2 = 12;
+
+		return IIO_VAL_FRACTIONAL_LOG2;
+	default:
+		return -EINVAL;
+	}
+}
+
+static const struct iio_info max1241_info = {
+	.read_raw = max1241_read_raw,
+};
+
+static void max1241_disable_reg_action(void *data)
+{
+	struct max1241 *adc = data;
+	int err;
+

drivers/iio/adc/max1241.c line 134

Quoted 10 lines
drivers/iio/adc/max1241.c new file +10 -0
+	err = regulator_disable(adc->reg);
+	if (err)
+		dev_err(&adc->spi->dev, "could not disable reference regulator.\n");
+}
+
+static int max1241_probe(struct spi_device *spi)
+{
+	struct iio_dev *indio_dev;
+	struct max1241 *adc;
+	int ret = 0;

Looks like ret is always set in all the paths that can use it. Hence no need to initialize here.

Quoted 72 lines
drivers/iio/adc/max1241.c new file +72 -0
+
+	indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*adc));
+	if (!indio_dev)
+		return -ENOMEM;
+
+	adc = iio_priv(indio_dev);
+	adc->spi = spi;
+	mutex_init(&adc->lock);
+
+	spi_set_drvdata(spi, indio_dev);
+
+	adc->reg = devm_regulator_get(&spi->dev, "vref");
+	if (IS_ERR(adc->reg)) {
+		dev_err(&spi->dev, "failed to get vref regulator\n");
+		return PTR_ERR(adc->reg);
+	}
+
+	ret = regulator_enable(adc->reg);
+	if (ret)
+		return ret;
+
+	ret = devm_add_action_or_reset(&spi->dev, max1241_disable_reg_action,
+					adc);
+	if (ret) {
+		dev_err(&spi->dev, "could not set up regulator cleanup action!\n");
+		return ret;
+	}
+
+	adc->shdn = devm_gpiod_get_optional(&spi->dev, "shdn", GPIOD_OUT_HIGH);
+
+	if (IS_ERR(adc->shdn))
+		return PTR_ERR(adc->shdn);
+
+	if (!adc->shdn)
+		dev_dbg(&spi->dev, "no shdn pin passed, low-power mode disabled");
+	else
+		dev_dbg(&spi->dev, "shdn pin passed, low-power mode enabled");
+
+	indio_dev->name = spi_get_device_id(spi)->name;
+	indio_dev->dev.parent = &spi->dev;
+	indio_dev->info = &max1241_info;
+	indio_dev->modes = INDIO_DIRECT_MODE;
+	indio_dev->channels = max1241_channels;
+	indio_dev->num_channels = ARRAY_SIZE(max1241_channels);
+
+	return devm_iio_device_register(&spi->dev, indio_dev);
+}
+
+static const struct spi_device_id max1241_id[] = {
+	{ "max1241", max1241 },
+	{},
+};
+
+static const struct of_device_id max1241_dt_ids[] = {
+	{ .compatible = "maxim,max1241" },
+	{},
+};
+MODULE_DEVICE_TABLE(of, max1241_dt_ids);
+
+static struct spi_driver max1241_spi_driver = {
+	.driver = {
+		.name = "max1241",
+		.of_match_table = max1241_dt_ids,
+	},
+	.probe = max1241_probe,
+	.id_table = max1241_id,
+};
+module_spi_driver(max1241_spi_driver);
+
+MODULE_AUTHOR("Alexandru Lazar <[email protected]>");
+MODULE_DESCRIPTION("MAX1241 ADC driver");
+MODULE_LICENSE("GPL v2");
#13 lore raw

Re: [PATCH v4 2/2] iio: adc: Add MAX1241 driver

In reply to Alexandru Lazar
Quoted 2 lines · Alexandru Lazar

Add driver for the Maxim MAX1241 12-bit, single-channel ADC. The driver includes support for this device's low-power operation mode.

...

drivers/iio/adc/max1241.c line 13

Quoted 6 lines
drivers/iio/adc/max1241.c new file +6 -0
+#include <linux/regulator/consumer.h>
+#include <linux/delay.h>
+#include <linux/gpio/consumer.h>
+#include <linux/iio/iio.h>
+#include <linux/module.h>
+#include <linux/spi/spi.h>

I think you can keep them sorted.

...

Quoted 1 line

+#define MAX1241_VAL_MASK 0xFFF

GENMASK() ?

...

drivers/iio/adc/max1241.c line 90

Quoted 9 lines
drivers/iio/adc/max1241.c new file +9 -0
+		if (adc->shdn) {
+			gpiod_set_value(adc->shdn, 0);
+			udelay(MAX1241_SHDN_DELAY_USEC);
+		}
+
+		ret = max1241_read(adc);
+
+		if (adc->shdn)
+			gpiod_set_value(adc->shdn, 1);

I guess easier to read in a way

		if () {
			gpio...
			read();
			gpio...
		} else {
			read();
		}

Or actually introduce runtime PM and move these gpio calls there.

...

drivers/iio/adc/max1241.c line 134

Quoted 6 lines
drivers/iio/adc/max1241.c new file +5 -0
+static int max1241_probe(struct spi_device *spi)
+{
+	struct iio_dev *indio_dev;
+	struct max1241 *adc;
 
+	int ret = 0;

Redundant assignment.

drivers/iio/adc/max1241.c line 157

Quoted 7 lines
drivers/iio/adc/max1241.c new file +6 -0
+	ret = regulator_enable(adc->reg);
+	if (ret)
+		return ret;
+
 
+	ret = devm_add_action_or_reset(&spi->dev, max1241_disable_reg_action,
+					adc);

Introducing

	struct device *dev = &spi->dev;

will simplifies such lines like above by making them on one line.

drivers/iio/adc/max1241.c line 164

Quoted 8 lines
drivers/iio/adc/max1241.c new file +6 -0
+	if (ret) {
+		dev_err(&spi->dev, "could not set up regulator cleanup action!\n");
+		return ret;
+	}
 
+	adc->shdn = devm_gpiod_get_optional(&spi->dev, "shdn", GPIOD_OUT_HIGH);
 
+

Redundant blank line.

drivers/iio/adc/max1241.c line 168

Quoted 4 lines
drivers/iio/adc/max1241.c new file +3 -0
+	if (IS_ERR(adc->shdn))
+		return PTR_ERR(adc->shdn);
 
+	if (!adc->shdn)

Why not to use positive conditional?

Quoted 5 lines
drivers/iio/adc/max1241.c new file +4 -0
+		dev_dbg(&spi->dev, "no shdn pin passed, low-power mode disabled");
+	else
+		dev_dbg(&spi->dev, "shdn pin passed, low-power mode enabled");
 
+}

...

drivers/iio/adc/max1241.c line 185

Quoted 4 lines
drivers/iio/adc/max1241.c new file +3 -0
+static const struct spi_device_id max1241_id[] = {
+	{ "max1241", max1241 },
 
+	{},

Terminators better w/o comma.

drivers/iio/adc/max1241.c line 190

Quoted 6 lines
drivers/iio/adc/max1241.c new file +5 -0
+};
+
+static const struct of_device_id max1241_dt_ids[] = {
+	{ .compatible = "maxim,max1241" },
 
+	{},

Ditto.

Quoted 1 line

+};

Signature · 2 lines
With Best Regards,
Andy Shevchenko