iio: magnetometer: ak8975: Add gpio reset support
Subsystems (2)
v5 cover iio: magnetometer: ak8975: Add gpio reset support
v5:
- add maintainer
v4:
- fix some typo
- use gpio's dt-bindings for more clarity in documentation
- set compatible properties without vendor prefix as deprecated
https://lore.kernel.org/linux-iio/[email protected]/
v3:
- fix patch messages style
- align reset gpio comment to kernel doc reccomendation
- introduce changelog
https://lore.kernel.org/linux-iio/[email protected]/
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 datasheet 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 format to yaml, add
maintainer
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 | 77 +++++++++++++++++++ drivers/iio/magnetometer/ak8975.c | 22 +++++- 3 files changed, 97 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
PATCH v5 1/4 dt-bindings: iio: magnetometer: ak8975: convert format to yaml, add maintainer
Converts documentation from txt format to yaml.
--- .../bindings/iio/magnetometer/ak8975.txt | 30 -------- .../bindings/iio/magnetometer/ak8975.yaml | 71 +++++++++++++++++++ 2 files changed, 71 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
@@ -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 +71 -0
71 lines not on this page · raw message
Signature · 1 line
2.17.1
Jonathan Cameron
maintainerRe: [PATCH v5 1/4] dt-bindings: iio: magnetometer: ak8975: convert format to yaml, add maintainer
Quoted 3 lines · On Wed, 20 May 2020 18:34:06 +0200 Jonathan Albrieux…
Converts documentation from txt format to yaml.
Signed-off-by Jonathan Albrieux <[email protected]>
An additional request inline. Doesn't effect this patch 'as such'.
Also the file name thing just below here.
Quoted 3 lines
--- .../bindings/iio/magnetometer/ak8975.txt | 30 -------- .../bindings/iio/magnetometer/ak8975.yaml | 71 +++++++++++++++++++
File naming should match the compatible.
ashahi-kasei,ak8975.yaml
Quoted 69 lines
2 files changed, 71 insertions(+), 30 deletions(-) delete mode 100644 Documentation/devicetree/bindings/iio/magnetometer/ak8975.txt create mode 100644 Documentation/devicetree/bindings/iio/magnetometer/ak8975.yamlDocumentation/devicetree/bindings/iio/magnetometer/ak8975.txt deleted +0
-30@@ -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 +23
-0@@ -0,0 +1,71 @@ +# 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: + - Jonathan Albrieux <[email protected]> + +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
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml line 33
Quoted 10 lines
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml new file +10
-0+ deprecated: true + - const: ak09912 + deprecated: true + + reg: + maxItems: 1 + description: the I2C address of the magnetometer + + gpios: + description: should be device tree identifier of the magnetometer DRDY pin
Nothing to do with your patch obviously but this is horrible...
+ the driver will quite happily take an interrupt instead.
Do you mind documenting the interrupt here as well?
Should be a separate patch though. So a follow up one to this one. The arch/arm/boot/dts/motorola-mapphone-common.dtsi does it that way, unlike the samsung s3 which uses the gpio binding (I think it's the only one against quite a few using interrupts).
Also switch the example to an interrupts one so we don't encourage anyone to go the gpios route.
Note can be a follow up if this series is otherwise ready to go.
Quoted 38 lines
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml new file +38
-0+ + 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: + - | + #include <dt-bindings/gpio/gpio.h> + i2c@78b7000 { + reg = <0x78b6000 0x600>; + #address-cells = <1>; + #size-cells = <0>; + + magnetometer@c { + compatible = "asahi-kasei,ak8975"; + reg = <0x0c>; + gpios = <&gpj0 7 GPIO_ACTIVE_HIGH>; + 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 */ + }; + };
Re: [PATCH v5 1/4] dt-bindings: iio: magnetometer: ak8975: convert format to yaml, add maintainer
Quoted 9 lines · Jonathan Cameron
Quoted 3 lines · On Wed, 20 May 2020 18:34:06 +0200 Jonathan Albrieux…
Converts documentation from txt format to yaml.
Signed-off-by Jonathan Albrieux <[email protected]>An additional request inline. Doesn't effect this patch 'as such'.
Quoted 9 lines
Also the file name thing just below here.
Quoted 3 lines
--- .../bindings/iio/magnetometer/ak8975.txt | 30 -------- .../bindings/iio/magnetometer/ak8975.yaml | 71 +++++++++++++++++++File naming should match the compatible.
ashahi-kasei,ak8975.yaml
Ok, I'll take this as general rule then :-)
Quoted 92 lines
Quoted 69 lines
2 files changed, 71 insertions(+), 30 deletions(-) delete mode 100644 Documentation/devicetree/bindings/iio/magnetometer/ak8975.txt create mode 100644 Documentation/devicetree/bindings/iio/magnetometer/ak8975.yamlDocumentation/devicetree/bindings/iio/magnetometer/ak8975.txt deleted +0
-30@@ -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 +23
-0@@ -0,0 +1,71 @@ +# 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: + - Jonathan Albrieux <[email protected]> + +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: ak09911Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml line 33
Quoted 10 lines
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml new file +10
-0+ deprecated: true + - const: ak09912 + deprecated: true + + reg: + maxItems: 1 + description: the I2C address of the magnetometer + + gpios: + description: should be device tree identifier of the magnetometer DRDY pinNothing to do with your patch obviously but this is horrible...
+ the driver will quite happily take an interrupt instead.Do you mind documenting the interrupt here as well?
Should be a separate patch though. So a follow up one to this one. The
arch/arm/boot/dts/motorola-mapphone-common.dtsidoes it that way, unlike the samsung s3 which uses the gpio binding (I think it's the only one against quite a few using interrupts).
Quoted 5 lines
Also switch the example to an interrupts one so we don't encourage anyone to go the gpios route.
Note can be a follow up if this series is otherwise ready to go.
Oh ok, will add a new patch for that in this series if you don't mind. It may even be better to split this series in two given the amount of changes to the documentation outnumbered the changes related to the driver itself, the first one regarding just the conversion to yaml and clean-up-related changes to documentation and the second one, depending on the first one, with the reset-related changes.
Do you have advices on which of the two should be the best strategy?
I'll prepare both the versions today in order to choose the right one once the path to follow has been decided,
Thank you,
Best regards,
Jonathan Albrieux
Quoted 40 lines
Quoted 39 lines
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml new file +38
-0+ + 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: + - | + #include <dt-bindings/gpio/gpio.h> + i2c@78b7000 { + reg = <0x78b6000 0x600>; + #address-cells = <1>; + #size-cells = <0>; + + magnetometer@c { + compatible = "asahi-kasei,ak8975"; + reg = <0x0c>; + gpios = <&gpj0 7 GPIO_ACTIVE_HIGH>; + 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 */ + }; + };
PATCH v5 2/4 dt-bindings: iio: magnetometer: ak8975: add gpio reset support
In reply to Jonathan AlbrieuxAdd 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 datasheet says that, if not used, reset pin should be connected to VID. This patch emulates this situation.
--- .../devicetree/bindings/iio/magnetometer/ak8975.yaml | 6 ++++++ 1 file changed, 6 insertions(+)
Documentation/devicetree/bindings/iio/magnetometer/ak8975.yaml +6 -0
@@ -41,6 +41,11 @@ properties: mount-matrix: description: an optional 3x3 mounting rotation matrix + reset-gpio: + description: | + an optional pin needed for AK09911 to set the reset state. This should + be usually active low + required: - compatible - reg
@@ -58,6 +63,7 @@ examples: reg = <0x0c>; gpios = <&gpj0 7 GPIO_ACTIVE_HIGH>; vdd-supply = <&ldo_3v3_gnss>; + reset-gpio = <&msmgpio 111 GPIO_ACTIVE_LOW>; mount-matrix = "-0.984807753012208", /* x0 */ "0", /* y0 */ "-0.173648177666930", /* z0 */
Signature · 1 line
2.17.1
PATCH v5 3/4 iio: magnetometer: ak8975: Fix typo, uniform measurement unit style
In reply to Jonathan AlbrieuxMinor comment style edits.
--- drivers/iio/magnetometer/ak8975.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/iio/magnetometer/ak8975.c +2 -2
@@ -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
PATCH v5 4/4 iio: magnetometer: ak8975: Add gpio reset support
In reply to Jonathan AlbrieuxAccording 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 datasheet 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
@@ -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
Jonathan Cameron
maintainerQuoted 6 lines · On Wed, 20 May 2020 18:34:09 +0200 Jonathan Albrieux…
According to AK09911 datasheet, if reset gpio is provided then deassert reset on
ak8975_power_on()and assert reset onak8975_power_off().Without reset's deassertion during
ak8975_power_on(), driver's probe fails onak8975_who_i_am()while checking for device identity for AK09911 chip.
Quoted 7 lines
AK09911 has an active low reset gpio to handle register's reset. AK09911 datasheet says that, if not used, reset pin should be connected to VID. This patch emulates this situation.
Signed-off-by Jonathan Albrieux <[email protected]>Reviewed-by Andy Shevchenko <[email protected]>Reviewed-by Stephan Gerhold <[email protected]>
Looks good to me. Just the minor stuff with the binding plus giving time for a binding review to go.
Thanks,
Jonathan
Quoted 68 lines
--- drivers/iio/magnetometer/ak8975.c | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+)drivers/iio/magnetometer/ak8975.c +18
-0@@ -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);