Skip to contentSkip to conversation

iio: magnetometer: ak8975: Add gpio reset support

PATCH Superseded Jonathan Albrieux 4 participants 18 messages May 19, 2020 – May 20, 2020

Subsystems (2)

v3 of 6 Superseded Latest is v6 →

lore
Share & tools
lore
#0 lore raw

v3 cover iio: magnetometer: ak8975: Add gpio reset support

v3:
- fix patch messages style
- align reset gpio comment to kernel doc reccomendation
- introduce changelog.

v2:
- rewording of reset gpio comment and patch messages to better clarify reset gpio behaviour.
https://lore.kernel.org/linux-iio/[email protected]/

v1:
- initial patch submission.
https://lore.kernel.org/linux-iio/[email protected]/

Convert documentation from txt format to yaml. Add documentation about reset-gpio.

Deassert reset on ak8975_power_on(), assert reset on ak8975_power_off().

Without reset's deassertion during ak8975_power_on(), driver's probe fails on ak8975_who_i_am() while checking for device identity for AK09911 chip.

AK09911 has an active low reset gpio to handle register's reset. AK09911 datasheed says that, if not used, reset pin should be connected to VID. This patch emulates this situation.

Jonathan Albrieux (4):
dt-bindings: iio: magnetometer: ak8975: convert txt format to yaml
dt-bindings: iio: magnetometer: ak8975: add gpio reset support
iio: magnetometer: ak8975: Fix typo, uniform measurement unit style
iio: magnetometer: ak8975: Add gpio reset support

 .../bindings/iio/magnetometer/ak8975.txt      | 30 --------
 .../bindings/iio/magnetometer/ak8975.yaml     | 70 +++++++++++++++++++
 drivers/iio/magnetometer/ak8975.c             | 22 +++++-
 3 files changed, 90 insertions(+), 32 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/iio/magnetometer/ak8975.txt
 create mode 100644 Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml
Signature · 1 line
2.17.1
#1 lore raw

PATCH v3 1/4 dt-bindings: iio: magnetometer: ak8975: convert txt format to yaml

Converts documentation from txt format to yaml.

---
 .../bindings/iio/magnetometer/ak8975.txt      | 30 ---------
 .../bindings/iio/magnetometer/ak8975.yaml     | 66 +++++++++++++++++++
 2 files changed, 66 insertions(+), 30 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/iio/magnetometer/ak8975.txt
 create mode 100644 Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml
Documentation/devicetree/bindings/iio/magnetometer/ak8975.txt deleted +0 -30
deleted file mode 100644
index aa67ceb0d4e0..000000000000
@@ -1,30 +0,0 @@
-* AsahiKASEI AK8975 magnetometer sensor
-
-Required properties:
-
-  - compatible : should be "asahi-kasei,ak8975"
-  - reg : the I2C address of the magnetometer
-
-Optional properties:
-
-  - gpios : should be device tree identifier of the magnetometer DRDY pin
-  - vdd-supply: an optional regulator that needs to be on to provide VDD
-  - mount-matrix: an optional 3x3 mounting rotation matrix
-
-Example:
-
-ak8975@c {
-        compatible = "asahi-kasei,ak8975";
-        reg = <0x0c>;
-        gpios = <&gpj0 7 0>;
-        vdd-supply = <&ldo_3v3_gnss>;
-        mount-matrix = "-0.984807753012208",  /* x0 */
-                       "0",                   /* y0 */
-                       "-0.173648177666930",  /* z0 */
-                       "0",                   /* x1 */
-                       "-1",                  /* y1 */
-                       "0",                   /* z1 */
-                       "-0.173648177666930",  /* x2 */
-                       "0",                   /* y2 */
-                       "0.984807753012208";   /* z2 */
-};
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml new file +66 -0

66 lines not on this page · raw message

Signature · 1 line
2.17.1
#2 lore raw

Re: [PATCH v3 1/4] dt-bindings: iio: magnetometer: ak8975: convert txt format to yaml

Quoted 52 lines · Jonathan Albrieux

Converts documentation from txt format to yaml.

---
 .../bindings/iio/magnetometer/ak8975.txt      | 30 ---------
 .../bindings/iio/magnetometer/ak8975.yaml     | 66 +++++++++++++++++++
 2 files changed, 66 insertions(+), 30 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/iio/magnetometer/ak8975.txt
 create mode 100644 Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml
Documentation/devicetree/bindings/iio/magnetometer/ak8975.txt deleted +0 -30
deleted file mode 100644
index aa67ceb0d4e0..000000000000
@@ -1,30 +0,0 @@
-* AsahiKASEI AK8975 magnetometer sensor
-
-Required properties:
-
-  - compatible : should be "asahi-kasei,ak8975"
-  - reg : the I2C address of the magnetometer
-
-Optional properties:
-
-  - gpios : should be device tree identifier of the magnetometer DRDY pin
-  - vdd-supply: an optional regulator that needs to be on to provide VDD
-  - mount-matrix: an optional 3x3 mounting rotation matrix
-
-Example:
-
-ak8975@c {
-        compatible = "asahi-kasei,ak8975";
-        reg = <0x0c>;
-        gpios = <&gpj0 7 0>;
-        vdd-supply = <&ldo_3v3_gnss>;
-        mount-matrix = "-0.984807753012208",  /* x0 */
-                       "0",                   /* y0 */
-                       "-0.173648177666930",  /* z0 */
-                       "0",                   /* x1 */
-                       "-1",                  /* y1 */
-                       "0",                   /* z1 */
-                       "-0.173648177666930",  /* x2 */
-                       "0",                   /* y2 */
-                       "0.984807753012208";   /* z2 */
-};
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml new file +0 -0
new file mode 100644
index 000000000000..86e3efa693a8

Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml line 10

Quoted 10 lines
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml new file +10 -0
@@ -0,0 +1,66 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/magnetometer/ak8975.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: AsahiKASEI AK8975 magnetometer sensor
+
+maintainers:
+  - can't find a mantainer, author is Laxman Dewangan <[email protected]>

Should probably add someone here, although I'm not sure who either.

Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml line 23

Quoted 13 lines
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml new file +13 -0
+
+properties:
+  compatible:
+    enum:
+      - "asahi-kasei,ak8975"
+      - "ak8975"
+      - "asahi-kasei,ak8963"
+      - "ak8963"
+      - "asahi-kasei,ak09911"
+      - "ak09911"
+      - "asahi-kasei,ak09912"
+      - "ak09912"
+

I wonder if the ones without vendor prefix (asahi-kasei,) should be marked as deprecated somehow?

Looking at some other schemas I see either a "# deprecated" comment, or:

properties:
compatible:
oneOf:
- const: asahi-kasei,ak8975
- const: asahi-kasei,ak8963
- const: asahi-kasei,ak09911
- const: asahi-kasei,ak09912
- const: ak8975
deprecated: true
- const: ak8963
deprecated: true
- const: ak09911
deprecated: true
- const: ak09912
deprecated: true

(e.g. in Documentation/devicetree/bindings/sound/samsung,odroid.yaml) I guess this one is preferred since it allows parsing those compatibles as deprecated?

Quoted 18 lines
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml new file +18 -0
+  reg:
+    maxItems: 1
+    description: the I2C address of the magnetometer
+
+  gpios:
+    description: should be device tree identifier of the magnetometer DRDY pin
+
+  vdd-supply:
+    maxItems: 1
+    description: |
+      an optional regulator that needs to be on to provide VDD power to
+      the sensor.
+
+  mount-matrix:
+    description: an optional 3x3 mounting rotation matrix
+
+required:
+  - compatible

Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml line 51

Quoted 10 lines
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml new file +10 -0
+  - reg
+
+examples:
+  - |
+    i2c@78b7000 {
+        reg = <0x78b6000 0x600>;
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        ak8975@c {

Per device tree specification this should preferably use a generic name describing the function of the device, i.e. magnetometer@c.

Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml line 54

Quoted 3 lines
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml new file +3 -0
+            compatible = "asahi-kasei,ak8975";
+            reg = <0x0c>;
+            gpios = <&gpj0 7 0>;

I think using the dt-bindings constants for the GPIO flags is preferred now, i.e. gpios = <&gpj0 7 GPIO_ACTIVE_HIGH>.

Quoted 14 lines
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml new file +12 -0
+            vdd-supply = <&ldo_3v3_gnss>;
+            mount-matrix = "-0.984807753012208",  /* x0 */
+                           "0",                   /* y0 */
+                           "-0.173648177666930",  /* z0 */
+                           "0",                   /* x1 */
+                           "-1",                  /* y1 */
+                           "0",                   /* z1 */
+                           "-0.173648177666930",  /* x2 */
+                           "0",                   /* y2 */
+                           "0.984807753012208";   /* z2 */
+        };
+    };
Signature · 1 line
2.17.1
#3 lore raw

Re: [PATCH v3 1/4] dt-bindings: iio: magnetometer: ak8975: convert txt format to yaml

Quoted 57 lines · Stephan Gerhold
Quoted 56 lines · Jonathan Albrieux

Converts documentation from txt format to yaml.

---
 .../bindings/iio/magnetometer/ak8975.txt      | 30 ---------
 .../bindings/iio/magnetometer/ak8975.yaml     | 66 +++++++++++++++++++
 2 files changed, 66 insertions(+), 30 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/iio/magnetometer/ak8975.txt
 create mode 100644 Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml
Documentation/devicetree/bindings/iio/magnetometer/ak8975.txt deleted +0 -30
deleted file mode 100644
index aa67ceb0d4e0..000000000000
@@ -1,30 +0,0 @@
-* AsahiKASEI AK8975 magnetometer sensor
-
-Required properties:
-
-  - compatible : should be "asahi-kasei,ak8975"
-  - reg : the I2C address of the magnetometer
-
-Optional properties:
-
-  - gpios : should be device tree identifier of the magnetometer DRDY pin
-  - vdd-supply: an optional regulator that needs to be on to provide VDD
-  - mount-matrix: an optional 3x3 mounting rotation matrix
-
-Example:
-
-ak8975@c {
-        compatible = "asahi-kasei,ak8975";
-        reg = <0x0c>;
-        gpios = <&gpj0 7 0>;
-        vdd-supply = <&ldo_3v3_gnss>;
-        mount-matrix = "-0.984807753012208",  /* x0 */
-                       "0",                   /* y0 */
-                       "-0.173648177666930",  /* z0 */
-                       "0",                   /* x1 */
-                       "-1",                  /* y1 */
-                       "0",                   /* z1 */
-                       "-0.173648177666930",  /* x2 */
-                       "0",                   /* y2 */
-                       "0.984807753012208";   /* z2 */
-};
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml new file +4 -0
new file mode 100644
index 000000000000..86e3efa693a8
@@ -0,0 +1,66 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/magnetometer/ak8975.yaml#
Quoted 9 lines

Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml line 10

Quoted 6 lines
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml new file +6 -0
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: AsahiKASEI AK8975 magnetometer sensor
+
+maintainers:
+  - can't find a mantainer, author is Laxman Dewangan <[email protected]>

Should probably add someone here, although I'm not sure who either.

Yep I couldn't find a maintainer for that driver..what to do in this case?

Quoted 35 lines

Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml line 23

Quoted 13 lines
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml new file +13 -0
+
+properties:
+  compatible:
+    enum:
+      - "asahi-kasei,ak8975"
+      - "ak8975"
+      - "asahi-kasei,ak8963"
+      - "ak8963"
+      - "asahi-kasei,ak09911"
+      - "ak09911"
+      - "asahi-kasei,ak09912"
+      - "ak09912"
+

I wonder if the ones without vendor prefix (asahi-kasei,) should be marked as deprecated somehow?

Looking at some other schemas I see either a "# deprecated" comment, or:

properties:
compatible:
oneOf:
- const: asahi-kasei,ak8975
- const: asahi-kasei,ak8963
- const: asahi-kasei,ak09911
- const: asahi-kasei,ak09912
- const: ak8975
deprecated: true
- const: ak8963
deprecated: true
- const: ak09911
deprecated: true
- const: ak09912
deprecated: true

Quoted 4 lines

(e.g. in Documentation/devicetree/bindings/sound/samsung,odroid.yaml) I guess this one is preferred since it allows parsing those compatibles as deprecated?

Ok I'll work on it

Quoted 23 lines
Quoted 23 lines
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml new file +23 -0
+  reg:
+    maxItems: 1
+    description: the I2C address of the magnetometer
+
+  gpios:
+    description: should be device tree identifier of the magnetometer DRDY pin
+
+  vdd-supply:
+    maxItems: 1
+    description: |
+      an optional regulator that needs to be on to provide VDD power to
+      the sensor.
+
+  mount-matrix:
+    description: an optional 3x3 mounting rotation matrix
+
+required:
+  - compatible
+  - reg
+
+examples:
+  - |
+    i2c@78b7000 {
Quoted 13 lines

Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml line 51

Quoted 5 lines
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml new file +5 -0
+        reg = <0x78b6000 0x600>;
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        ak8975@c {

Per device tree specification this should preferably use a generic name describing the function of the device, i.e. magnetometer@c.

Quoted 3 lines
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml new file +3 -0
+            compatible = "asahi-kasei,ak8975";
+            reg = <0x0c>;
+            gpios = <&gpj0 7 0>;

Yes it would be better, I'll work on that too

Quoted 17 lines

I think using the dt-bindings constants for the GPIO flags is preferred now, i.e. gpios = <&gpj0 7 GPIO_ACTIVE_HIGH>.

Quoted 14 lines
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml new file +12 -0
+            vdd-supply = <&ldo_3v3_gnss>;
+            mount-matrix = "-0.984807753012208",  /* x0 */
+                           "0",                   /* y0 */
+                           "-0.173648177666930",  /* z0 */
+                           "0",                   /* x1 */
+                           "-1",                  /* y1 */
+                           "0",                   /* z1 */
+                           "-0.173648177666930",  /* x2 */
+                           "0",                   /* y2 */
+                           "0.984807753012208";   /* z2 */
+        };
+    };
Signature · 1 line
2.17.1

Thank you for having took the time to review, will work on edits right now. I just have a question: by creating the new patchset how can I deal with the "Reviewed by"? It's the first patch I submit and still haven't dealt with the full process,

Best regards,
Jonathan Albrieux

#4 lore raw

Re: [PATCH v3 1/4] dt-bindings: iio: magnetometer: ak8975: convert txt format to yaml

Quoted 2 lines · Jonathan Albrieux
Quoted 1 line · Stephan Gerhold

On Tue, May 19, 2020 at 02:43:51PM +0200, Jonathan Albrieux wrote:

...

Quoted 7 lines
Quoted 5 lines

Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml line 10

Quoted 2 lines
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml new file +2 -0
+maintainers:
+  - can't find a mantainer, author is Laxman Dewangan <[email protected]>

Should probably add someone here, although I'm not sure who either.

Yep I couldn't find a maintainer for that driver..what to do in this case?

Volunteer yourself!

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#5 lore raw

Re: [PATCH v3 1/4] dt-bindings: iio: magnetometer: ak8975: convert txt format to yaml

Quoted 9 lines · Andy Shevchenko
Quoted 2 lines · Jonathan Albrieux
Quoted 1 line · Stephan Gerhold

On Tue, May 19, 2020 at 02:43:51PM +0200, Jonathan Albrieux wrote:

...

Quoted 3 lines
Quoted 3 lines
Quoted 2 lines
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml new file +2 -0
+maintainers:
+  - can't find a mantainer, author is Laxman Dewangan <[email protected]>
Quoted 7 lines
Quoted 4 lines
Quoted 2 lines

Should probably add someone here, although I'm not sure who either.

Yep I couldn't find a maintainer for that driver..what to do in this case?

Volunteer yourself!

While I'd really like to, I have to decline the offer as I currently don't have enought knowledge to become a maintainer :-) but thank you! (Who knows, maybe in a couple of year!) Now I'll make the final edits and will submit a new patchset soon with all the changes

Quoted 5 lines
Signature · 2 lines
With Best Regards,
Andy Shevchenko

Best regards,
Jonathan Albrieux

#6 lore raw

Re: [PATCH v3 1/4] dt-bindings: iio: magnetometer: ak8975: convert txt format to yaml

Quoted 15 lines · On Tue, 19 May 2020 18:44:33 +0200 Jonathan Albrieux…
Quoted 14 lines · Andy Shevchenko
Quoted 2 lines · Jonathan Albrieux
Quoted 1 line · Stephan Gerhold

On Tue, May 19, 2020 at 02:43:51PM +0200, Jonathan Albrieux wrote:

...

Quoted 7 lines
Quoted 5 lines

Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml line 10

Quoted 2 lines
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml new file +2 -0
+maintainers:
+  - can't find a mantainer, author is Laxman Dewangan <[email protected]>  

Should probably add someone here, although I'm not sure who either.

Yep I couldn't find a maintainer for that driver..what to do in this case?

Quoted 7 lines
Quoted 2 lines

Volunteer yourself!

While I'd really like to, I have to decline the offer as I currently don't have enought knowledge to become a maintainer :-) but thank you! (Who knows, maybe in a couple of year!) Now I'll make the final edits and will submit a new patchset soon with all the changes

Don't be so hard on yourself. We all get thrown in at the deep end :)

Note that being a driver maintainer (or even just the binding) really just means you get cc'd on the patches and I'll make sure you've had time
to review them if you wish. Best of all, if you have hardware (and time)
being able to test them, that is extremely useful (whether you are maintaining the driver or not!)

I closely review the majority of stuff that comes through IIO and in the case of bindings we also have Rob and co. doing an amazing job. We have some excellent additional reviewers who review IIO stuff all the time, some of which have reviewed your patch I see. Without them I'd never survive the deluge.

Of course it's entirely your decision, but I'd definitely encourage you to give it a go.

Thanks,

Jonathan

Quoted 9 lines
Quoted 6 lines
Signature · 3 lines
-- 
With Best Regards,
Andy Shevchenko

Best regards,
Jonathan Albrieux

#7 lore raw

Re: [PATCH v3 1/4] dt-bindings: iio: magnetometer: ak8975: convert txt format to yaml

Quoted 40 lines · Jonathan Cameron
Quoted 15 lines · On Tue, 19 May 2020 18:44:33 +0200 Jonathan Albrieux…
Quoted 14 lines · Andy Shevchenko
Quoted 2 lines · Jonathan Albrieux
Quoted 1 line · Stephan Gerhold

On Tue, May 19, 2020 at 02:43:51PM +0200, Jonathan Albrieux wrote:

...

Quoted 7 lines
Quoted 5 lines

Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml line 10

Quoted 2 lines
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml new file +2 -0
+maintainers:
+  - can't find a mantainer, author is Laxman Dewangan <[email protected]>  

Should probably add someone here, although I'm not sure who either.

Yep I couldn't find a maintainer for that driver..what to do in this case?

Quoted 7 lines
Quoted 2 lines

Volunteer yourself!

While I'd really like to, I have to decline the offer as I currently don't have enought knowledge to become a maintainer :-) but thank you! (Who knows, maybe in a couple of year!) Now I'll make the final edits and will submit a new patchset soon with all the changes

Don't be so hard on yourself. We all get thrown in at the deep end :)

Note that being a driver maintainer (or even just the binding) really just means you get cc'd on the patches and I'll make sure you've had time
to review them if you wish. Best of all, if you have hardware (and time)
being able to test them, that is extremely useful (whether you are maintaining the driver or not!)

I closely review the majority of stuff that comes through IIO and in the case of bindings we also have Rob and co. doing an amazing job. We have some excellent additional reviewers who review IIO stuff all the time, some of which have reviewed your patch I see. Without them I'd never survive the deluge.

Quoted 7 lines

Of course it's entirely your decision, but I'd definitely encourage you to give it a go.

Thanks,

Jonathan

Thank you for your encouraging words and for the trust! As a tester I will be very pleased to give an help on this hardware but as a maintainer I could contribute little to nothing at the moment and I'm not being hard with myself but currently I really have to focus on the basic concepts first and I'm lucky enought to have willing people helping me to do so :-)

Accepting to become the maintainer after the first contribution let me feels like I'm burning some foundamental stage. I really hope you understand!

Quoted 13 lines
Quoted 11 lines
Quoted 8 lines
Signature · 3 lines
-- 
With Best Regards,
Andy Shevchenko

Best regards,
Jonathan Albrieux

Best regards,
Jonathan Albrieux

#8 lore raw

PATCH v3 2/4 dt-bindings: iio: magnetometer: ak8975: add gpio reset support

In reply to Jonathan Albrieux

Add reset-gpio support.

Without reset's deassertion during ak8975_power_on(), driver's probe fails on ak8975_who_i_am() while checking for device identity for AK09911 chip.

AK09911 has an active low reset gpio to handle register's reset. AK09911 datasheed says that, if not used, reset pin should be connected to VID. This patch emulates this situation.

---
 .../devicetree/bindings/iio/magnetometer/ak8975.yaml          | 4 ++++
 1 file changed, 4 insertions(+)
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml +4 -0
index 86e3efa693a8..a82c0ff5d098 100644
@@ -37,6 +37,9 @@ properties:
   mount-matrix:
     description: an optional 3x3 mounting rotation matrix
 
+  reset-gpio:
+    description: an optional pin needed for AK09911 to set the reset state
+
 required:
   - compatible
   - reg
@@ -53,6 +56,7 @@ examples:
             reg = <0x0c>;
             gpios = <&gpj0 7 0>;
             vdd-supply = <&ldo_3v3_gnss>;
+            reset-gpio = <&msmgpio 111 1>;
             mount-matrix = "-0.984807753012208",  /* x0 */
                            "0",                   /* y0 */
                            "-0.173648177666930",  /* z0 */
Signature · 1 line
2.17.1
#9 lore raw

Re: [PATCH v3 2/4] dt-bindings: iio: magnetometer: ak8975: add gpio reset support

Quoted 7 lines · Jonathan Albrieux

Add reset-gpio support.

Without reset's deassertion during ak8975_power_on(), driver's probe fails on ak8975_who_i_am() while checking for device identity for AK09911 chip.

AK09911 has an active low reset gpio to handle register's reset. AK09911 datasheed says that, if not used, reset pin should be connected

datasheed -> datasheet

Quoted 12 lines

to VID. This patch emulates this situation.

---
 .../devicetree/bindings/iio/magnetometer/ak8975.yaml          | 4 ++++
 1 file changed, 4 insertions(+)
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml +0 -0
index 86e3efa693a8..a82c0ff5d098 100644

Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml properties: · line 41

Quoted 5 lines
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml +2 -0
@@ -37,6 +37,9 @@ properties:
   mount-matrix:
     description: an optional 3x3 mounting rotation matrix
 
+  reset-gpio:
+    description: an optional pin needed for AK09911 to set the reset state

Maybe add a comment that this should be "usually active low".

Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml examples: · line 59

Quoted 9 lines
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml +2 -0
+
 required:
   - compatible
   - reg
@@ -53,6 +56,7 @@ examples:
             reg = <0x0c>;
             gpios = <&gpj0 7 0>;
             vdd-supply = <&ldo_3v3_gnss>;
+            reset-gpio = <&msmgpio 111 1>;

Same here, reset-gpio = <&msmgpio 111 GPIO_ACTIVE_LOW>, would be more clear.

Quoted 5 lines
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml +0 -0
             mount-matrix = "-0.984807753012208",  /* x0 */
                            "0",                   /* y0 */
                            "-0.173648177666930",  /* z0 */
Signature · 1 line
2.17.1
#10 lore raw

Re: [PATCH v3 2/4] dt-bindings: iio: magnetometer: ak8975: add gpio reset support

Quoted 11 lines · Stephan Gerhold
Quoted 7 lines · Jonathan Albrieux

Add reset-gpio support.

Without reset's deassertion during ak8975_power_on(), driver's probe fails on ak8975_who_i_am() while checking for device identity for AK09911 chip.

AK09911 has an active low reset gpio to handle register's reset. AK09911 datasheed says that, if not used, reset pin should be connected

datasheed -> datasheet

Will fix that soon

Quoted 20 lines
Quoted 12 lines

to VID. This patch emulates this situation.

---
 .../devicetree/bindings/iio/magnetometer/ak8975.yaml          | 4 ++++
 1 file changed, 4 insertions(+)
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml +0 -0
index 86e3efa693a8..a82c0ff5d098 100644

Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml properties: · line 41

Quoted 5 lines
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml +2 -0
@@ -37,6 +37,9 @@ properties:
   mount-matrix:
     description: an optional 3x3 mounting rotation matrix
 
+  reset-gpio:
+    description: an optional pin needed for AK09911 to set the reset state

Maybe add a comment that this should be "usually active low".

Quoted 18 lines

Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml examples: · line 59

Quoted 9 lines
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml +2 -0
+
 required:
   - compatible
   - reg
@@ -53,6 +56,7 @@ examples:
             reg = <0x0c>;
             gpios = <&gpj0 7 0>;
             vdd-supply = <&ldo_3v3_gnss>;
+            reset-gpio = <&msmgpio 111 1>;

Same here, reset-gpio = <&msmgpio 111 GPIO_ACTIVE_LOW>, would be more clear.

Quoted 5 lines
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml +0 -0
             mount-matrix = "-0.984807753012208",  /* x0 */
                            "0",                   /* y0 */
                            "-0.173648177666930",  /* z0 */
Signature · 1 line
2.17.1

Thank you for the suggestions, will work on them,

Best regards,
Jonathan Albrieux

#11 lore raw

PATCH v3 3/4 iio: magnetometer: ak8975: Fix typo, uniform measurement unit style

In reply to Jonathan Albrieux

Minor comment style edits.

---
 drivers/iio/magnetometer/ak8975.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/iio/magnetometer/ak8975.c +2 -2
index 3c881541ae72..fd368455cd7b 100644
@@ -385,9 +385,9 @@ static int ak8975_power_on(const struct ak8975_data *data)
 		return ret;
 	}
 	/*
-	 * According to the datasheet the power supply rise time i 200us
+	 * According to the datasheet the power supply rise time is 200us
 	 * and the minimum wait time before mode setting is 100us, in
-	 * total 300 us. Add some margin and say minimum 500us here.
+	 * total 300us. Add some margin and say minimum 500us here.
 	 */
 	usleep_range(500, 1000);
 	return 0;
Signature · 1 line
2.17.1
Reviewed-by on v3 3/4
#12 lore raw

Re: [PATCH v3 3/4] iio: magnetometer: ak8975: Fix typo, uniform measurement unit style

Quoted 1 line · Jonathan Albrieux

Minor comment style edits.

Quoted 24 lines
---
 drivers/iio/magnetometer/ak8975.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/iio/magnetometer/ak8975.c +2 -2
index 3c881541ae72..fd368455cd7b 100644
@@ -385,9 +385,9 @@ static int ak8975_power_on(const struct ak8975_data *data)
 		return ret;
 	}
 	/*
-	 * According to the datasheet the power supply rise time i 200us
+	 * According to the datasheet the power supply rise time is 200us
 	 * and the minimum wait time before mode setting is 100us, in
-	 * total 300 us. Add some margin and say minimum 500us here.
+	 * total 300us. Add some margin and say minimum 500us here.
 	 */
 	usleep_range(500, 1000);
 	return 0;
Signature · 1 line
2.17.1
Signature · 2 lines
With Best Regards,
Andy Shevchenko
#13 lore raw

PATCH v3 4/4 iio: magnetometer: ak8975: Add gpio reset support

In reply to Jonathan Albrieux

According to AK09911 datasheet, if reset gpio is provided then deassert reset on ak8975_power_on() and assert reset on ak8975_power_off().

Without reset's deassertion during ak8975_power_on(), driver's probe fails on ak8975_who_i_am while() checking for device identity for AK09911 chip.

AK09911 has an active low reset gpio to handle register's reset. AK09911 datasheed says that, if not used, reset pin should be connected to VID. This patch emulates this situation.

---
 drivers/iio/magnetometer/ak8975.c | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
drivers/iio/magnetometer/ak8975.c +18 -0
index fd368455cd7b..a23422aad97d 100644
@@ -358,6 +358,7 @@ struct ak8975_data {
 	u8			asa[3];
 	long			raw_to_gauss[3];
 	struct gpio_desc	*eoc_gpiod;
+	struct gpio_desc	*reset_gpiod;
 	int			eoc_irq;
 	wait_queue_head_t	data_ready_queue;
 	unsigned long		flags;
@@ -384,6 +385,9 @@ static int ak8975_power_on(const struct ak8975_data *data)
 			 "Failed to enable specified Vid supply\n");
 		return ret;
 	}
+
+	gpiod_set_value_cansleep(data->reset_gpiod, 0);
+
 	/*
 	 * According to the datasheet the power supply rise time is 200us
 	 * and the minimum wait time before mode setting is 100us, in
@@ -396,6 +400,8 @@ static int ak8975_power_on(const struct ak8975_data *data)
 /* Disable attached power regulator if any. */
 static void ak8975_power_off(const struct ak8975_data *data)
 {
+	gpiod_set_value_cansleep(data->reset_gpiod, 1);
+
 	regulator_disable(data->vid);
 	regulator_disable(data->vdd);
 }
@@ -839,6 +845,7 @@ static int ak8975_probe(struct i2c_client *client,
 	struct ak8975_data *data;
 	struct iio_dev *indio_dev;
 	struct gpio_desc *eoc_gpiod;
+	struct gpio_desc *reset_gpiod;
 	const void *match;
 	unsigned int i;
 	int err;
@@ -856,6 +863,16 @@ static int ak8975_probe(struct i2c_client *client,
 	if (eoc_gpiod)
 		gpiod_set_consumer_name(eoc_gpiod, "ak_8975");
 
+	/*
+	 * According to AK09911 datasheet, if reset GPIO is provided then
+	 * deassert reset on ak8975_power_on() and assert reset on
+	 * ak8975_power_off().
+	 */
+	reset_gpiod = devm_gpiod_get_optional(&client->dev,
+					      "reset", GPIOD_OUT_HIGH);
+	if (IS_ERR(reset_gpiod))
+		return PTR_ERR(reset_gpiod);
+
 	/* Register with IIO */
 	indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
 	if (indio_dev == NULL)
@@ -866,6 +883,7 @@ static int ak8975_probe(struct i2c_client *client,
 
 	data->client = client;
 	data->eoc_gpiod = eoc_gpiod;
+	data->reset_gpiod = reset_gpiod;
 	data->eoc_irq = 0;
 
 	err = iio_read_mount_matrix(&client->dev, "mount-matrix", &data->orientation);
Signature · 1 line
2.17.1
Reviewed-by on v3 4/4
#14 lore raw
Quoted 5 lines · Jonathan Albrieux

According to AK09911 datasheet, if reset gpio is provided then deassert reset on ak8975_power_on() and assert reset on ak8975_power_off().

Without reset's deassertion during ak8975_power_on(), driver's probe fails on ak8975_who_i_am while() checking for device identity for AK09911 chip.

Wrong position of (), but hold on, this is so minor, no need to send a new version because of this.

Quoted 3 lines

AK09911 has an active low reset gpio to handle register's reset. AK09911 datasheed says that, if not used, reset pin should be connected to VID. This patch emulates this situation.

Quoted 72 lines
---
 drivers/iio/magnetometer/ak8975.c | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
drivers/iio/magnetometer/ak8975.c +18 -0
index fd368455cd7b..a23422aad97d 100644
@@ -358,6 +358,7 @@ struct ak8975_data {
 	u8			asa[3];
 	long			raw_to_gauss[3];
 	struct gpio_desc	*eoc_gpiod;
+	struct gpio_desc	*reset_gpiod;
 	int			eoc_irq;
 	wait_queue_head_t	data_ready_queue;
 	unsigned long		flags;
@@ -384,6 +385,9 @@ static int ak8975_power_on(const struct ak8975_data *data)
 			 "Failed to enable specified Vid supply\n");
 		return ret;
 	}
+
+	gpiod_set_value_cansleep(data->reset_gpiod, 0);
+
 	/*
 	 * According to the datasheet the power supply rise time is 200us
 	 * and the minimum wait time before mode setting is 100us, in
@@ -396,6 +400,8 @@ static int ak8975_power_on(const struct ak8975_data *data)
 /* Disable attached power regulator if any. */
 static void ak8975_power_off(const struct ak8975_data *data)
 {
+	gpiod_set_value_cansleep(data->reset_gpiod, 1);
+
 	regulator_disable(data->vid);
 	regulator_disable(data->vdd);
 }
@@ -839,6 +845,7 @@ static int ak8975_probe(struct i2c_client *client,
 	struct ak8975_data *data;
 	struct iio_dev *indio_dev;
 	struct gpio_desc *eoc_gpiod;
+	struct gpio_desc *reset_gpiod;
 	const void *match;
 	unsigned int i;
 	int err;
@@ -856,6 +863,16 @@ static int ak8975_probe(struct i2c_client *client,
 	if (eoc_gpiod)
 		gpiod_set_consumer_name(eoc_gpiod, "ak_8975");
 
+	/*
+	 * According to AK09911 datasheet, if reset GPIO is provided then
+	 * deassert reset on ak8975_power_on() and assert reset on
+	 * ak8975_power_off().
+	 */
+	reset_gpiod = devm_gpiod_get_optional(&client->dev,
+					      "reset", GPIOD_OUT_HIGH);
+	if (IS_ERR(reset_gpiod))
+		return PTR_ERR(reset_gpiod);
+
 	/* Register with IIO */
 	indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
 	if (indio_dev == NULL)
@@ -866,6 +883,7 @@ static int ak8975_probe(struct i2c_client *client,
 
 	data->client = client;
 	data->eoc_gpiod = eoc_gpiod;
+	data->reset_gpiod = reset_gpiod;
 	data->eoc_irq = 0;
 
 	err = iio_read_mount_matrix(&client->dev, "mount-matrix", &data->orientation);
Signature · 1 line
2.17.1
Signature · 2 lines
With Best Regards,
Andy Shevchenko
#15 lore raw
Quoted 10 lines · Andy Shevchenko
Quoted 5 lines · Jonathan Albrieux

According to AK09911 datasheet, if reset gpio is provided then deassert reset on ak8975_power_on() and assert reset on ak8975_power_off().

Without reset's deassertion during ak8975_power_on(), driver's probe fails on ak8975_who_i_am while() checking for device identity for AK09911 chip.

Wrong position of (), but hold on, this is so minor, no need to send a new version because of this.

Ops, if this represents a problem I can fix it, there's absolutely no problem!

Quoted 74 lines
Quoted 3 lines

AK09911 has an active low reset gpio to handle register's reset. AK09911 datasheed says that, if not used, reset pin should be connected to VID. This patch emulates this situation.

Quoted 68 lines
---
 drivers/iio/magnetometer/ak8975.c | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
drivers/iio/magnetometer/ak8975.c +18 -0
index fd368455cd7b..a23422aad97d 100644
@@ -358,6 +358,7 @@ struct ak8975_data {
 	u8			asa[3];
 	long			raw_to_gauss[3];
 	struct gpio_desc	*eoc_gpiod;
+	struct gpio_desc	*reset_gpiod;
 	int			eoc_irq;
 	wait_queue_head_t	data_ready_queue;
 	unsigned long		flags;
@@ -384,6 +385,9 @@ static int ak8975_power_on(const struct ak8975_data *data)
 			 "Failed to enable specified Vid supply\n");
 		return ret;
 	}
+
+	gpiod_set_value_cansleep(data->reset_gpiod, 0);
+
 	/*
 	 * According to the datasheet the power supply rise time is 200us
 	 * and the minimum wait time before mode setting is 100us, in
@@ -396,6 +400,8 @@ static int ak8975_power_on(const struct ak8975_data *data)
 /* Disable attached power regulator if any. */
 static void ak8975_power_off(const struct ak8975_data *data)
 {
+	gpiod_set_value_cansleep(data->reset_gpiod, 1);
+
 	regulator_disable(data->vid);
 	regulator_disable(data->vdd);
 }
@@ -839,6 +845,7 @@ static int ak8975_probe(struct i2c_client *client,
 	struct ak8975_data *data;
 	struct iio_dev *indio_dev;
 	struct gpio_desc *eoc_gpiod;
+	struct gpio_desc *reset_gpiod;
 	const void *match;
 	unsigned int i;
 	int err;
@@ -856,6 +863,16 @@ static int ak8975_probe(struct i2c_client *client,
 	if (eoc_gpiod)
 		gpiod_set_consumer_name(eoc_gpiod, "ak_8975");
 
+	/*
+	 * According to AK09911 datasheet, if reset GPIO is provided then
+	 * deassert reset on ak8975_power_on() and assert reset on
+	 * ak8975_power_off().
+	 */
+	reset_gpiod = devm_gpiod_get_optional(&client->dev,
+					      "reset", GPIOD_OUT_HIGH);
+	if (IS_ERR(reset_gpiod))
+		return PTR_ERR(reset_gpiod);
+
 	/* Register with IIO */
 	indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
 	if (indio_dev == NULL)
@@ -866,6 +883,7 @@ static int ak8975_probe(struct i2c_client *client,
 
 	data->client = client;
 	data->eoc_gpiod = eoc_gpiod;
+	data->reset_gpiod = reset_gpiod;
 	data->eoc_irq = 0;
 
Quoted 10 lines
Quoted 4 lines
drivers/iio/magnetometer/ak8975.c +0 -0
 	err = iio_read_mount_matrix(&client->dev, "mount-matrix", &data->orientation);
Signature · 1 line
2.17.1
Signature · 2 lines
With Best Regards,
Andy Shevchenko

Best regards,
Jonathan Albrieux

Reviewed-by on v3 4/4
#16 lore raw
In reply to Jonathan Albrieux
Quoted 8 lines · Jonathan Albrieux

According to AK09911 datasheet, if reset gpio is provided then deassert reset on ak8975_power_on() and assert reset on ak8975_power_off().

Without reset's deassertion during ak8975_power_on(), driver's probe fails on ak8975_who_i_am while() checking for device identity for AK09911 chip.

AK09911 has an active low reset gpio to handle register's reset. AK09911 datasheed says that, if not used, reset pin should be connected

Another minor typo: datasheed -> datasheet

In any case, FWIW:

Quoted 73 lines

to VID. This patch emulates this situation.

---
 drivers/iio/magnetometer/ak8975.c | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
drivers/iio/magnetometer/ak8975.c +18 -0
index fd368455cd7b..a23422aad97d 100644
@@ -358,6 +358,7 @@ struct ak8975_data {
 	u8			asa[3];
 	long			raw_to_gauss[3];
 	struct gpio_desc	*eoc_gpiod;
+	struct gpio_desc	*reset_gpiod;
 	int			eoc_irq;
 	wait_queue_head_t	data_ready_queue;
 	unsigned long		flags;
@@ -384,6 +385,9 @@ static int ak8975_power_on(const struct ak8975_data *data)
 			 "Failed to enable specified Vid supply\n");
 		return ret;
 	}
+
+	gpiod_set_value_cansleep(data->reset_gpiod, 0);
+
 	/*
 	 * According to the datasheet the power supply rise time is 200us
 	 * and the minimum wait time before mode setting is 100us, in
@@ -396,6 +400,8 @@ static int ak8975_power_on(const struct ak8975_data *data)
 /* Disable attached power regulator if any. */
 static void ak8975_power_off(const struct ak8975_data *data)
 {
+	gpiod_set_value_cansleep(data->reset_gpiod, 1);
+
 	regulator_disable(data->vid);
 	regulator_disable(data->vdd);
 }
@@ -839,6 +845,7 @@ static int ak8975_probe(struct i2c_client *client,
 	struct ak8975_data *data;
 	struct iio_dev *indio_dev;
 	struct gpio_desc *eoc_gpiod;
+	struct gpio_desc *reset_gpiod;
 	const void *match;
 	unsigned int i;
 	int err;
@@ -856,6 +863,16 @@ static int ak8975_probe(struct i2c_client *client,
 	if (eoc_gpiod)
 		gpiod_set_consumer_name(eoc_gpiod, "ak_8975");
 
+	/*
+	 * According to AK09911 datasheet, if reset GPIO is provided then
+	 * deassert reset on ak8975_power_on() and assert reset on
+	 * ak8975_power_off().
+	 */
+	reset_gpiod = devm_gpiod_get_optional(&client->dev,
+					      "reset", GPIOD_OUT_HIGH);
+	if (IS_ERR(reset_gpiod))
+		return PTR_ERR(reset_gpiod);
+
 	/* Register with IIO */
 	indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
 	if (indio_dev == NULL)
@@ -866,6 +883,7 @@ static int ak8975_probe(struct i2c_client *client,
 
 	data->client = client;
 	data->eoc_gpiod = eoc_gpiod;
+	data->reset_gpiod = reset_gpiod;
 	data->eoc_irq = 0;
 
 	err = iio_read_mount_matrix(&client->dev, "mount-matrix", &data->orientation);
Signature · 1 line
2.17.1
#17 lore raw
Quoted 80 lines · Stephan Gerhold
Quoted 8 lines · Jonathan Albrieux

According to AK09911 datasheet, if reset gpio is provided then deassert reset on ak8975_power_on() and assert reset on ak8975_power_off().

Without reset's deassertion during ak8975_power_on(), driver's probe fails on ak8975_who_i_am while() checking for device identity for AK09911 chip.

AK09911 has an active low reset gpio to handle register's reset. AK09911 datasheed says that, if not used, reset pin should be connected

Another minor typo: datasheed -> datasheet

In any case, FWIW:

Quoted 65 lines

to VID. This patch emulates this situation.

---
 drivers/iio/magnetometer/ak8975.c | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
drivers/iio/magnetometer/ak8975.c +17 -0
index fd368455cd7b..a23422aad97d 100644
@@ -358,6 +358,7 @@ struct ak8975_data {
 	u8			asa[3];
 	long			raw_to_gauss[3];
 	struct gpio_desc	*eoc_gpiod;
+	struct gpio_desc	*reset_gpiod;
 	int			eoc_irq;
 	wait_queue_head_t	data_ready_queue;
 	unsigned long		flags;
@@ -384,6 +385,9 @@ static int ak8975_power_on(const struct ak8975_data *data)
 			 "Failed to enable specified Vid supply\n");
 		return ret;
 	}
+
+	gpiod_set_value_cansleep(data->reset_gpiod, 0);
+
 	/*
 	 * According to the datasheet the power supply rise time is 200us
 	 * and the minimum wait time before mode setting is 100us, in
@@ -396,6 +400,8 @@ static int ak8975_power_on(const struct ak8975_data *data)
 /* Disable attached power regulator if any. */
 static void ak8975_power_off(const struct ak8975_data *data)
 {
+	gpiod_set_value_cansleep(data->reset_gpiod, 1);
+
 	regulator_disable(data->vid);
 	regulator_disable(data->vdd);
 }
@@ -839,6 +845,7 @@ static int ak8975_probe(struct i2c_client *client,
 	struct ak8975_data *data;
 	struct iio_dev *indio_dev;
 	struct gpio_desc *eoc_gpiod;
+	struct gpio_desc *reset_gpiod;
 	const void *match;
 	unsigned int i;
 	int err;
@@ -856,6 +863,16 @@ static int ak8975_probe(struct i2c_client *client,
 	if (eoc_gpiod)
 		gpiod_set_consumer_name(eoc_gpiod, "ak_8975");
 
+	/*
+	 * According to AK09911 datasheet, if reset GPIO is provided then
+	 * deassert reset on ak8975_power_on() and assert reset on
+	 * ak8975_power_off().
+	 */
+	reset_gpiod = devm_gpiod_get_optional(&client->dev,
+					      "reset", GPIOD_OUT_HIGH);
+	if (IS_ERR(reset_gpiod))
+		return PTR_ERR(reset_gpiod);
+
 	/* Register with IIO */
 	indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
 	if (indio_dev == NULL)
@@ -866,6 +883,7 @@ static int ak8975_probe(struct i2c_client *client,
 
Quoted 8 lines
Quoted 8 lines
drivers/iio/magnetometer/ak8975.c +1 -0
 	data->client = client;
 	data->eoc_gpiod = eoc_gpiod;
+	data->reset_gpiod = reset_gpiod;
 	data->eoc_irq = 0;
 
 	err = iio_read_mount_matrix(&client->dev, "mount-matrix", &data->orientation);
Signature · 1 line
2.17.1

Thank you, will fix that typo too,

Best regards,
Jonathan Albrieux