[PATCH v4 0/4] Add support for AK09918

[PATCH v4 0/4] Add support for AK09918

[Barnabás Czémán]

Add support for AK09918 which is register and scaling compatible with
AK09912.

It was tested in Xiaomi Redmi 5 Plus (vince).

magnetometer@c {
  compatible = "asahi-kasei,ak09918", "asahi-kasei,ak09912";
  reg = <0x0c>;
  vdd-supply = <&pm8953_l6>;
  mount-matrix = "1", "0", "0",
                 "0", "1", "0",
                 "0", "0", "1";
};

Add a fix for data reading according to datasheet [1] (9.4.3.2.) 
ST2 register have to be read out after read measurment data as third step
because ST2 will realasing the lock on the measurment data. Without it
the next reading will fail.

[1] https://www.akm.com/content/dam/documents/products/electronic-compass/ak09918c/ak09918c-en-datasheet.pdf

Signed-off-by: Barnabás Czémán <barnabas.czeman@mainlining.org>
---
Changes in v4:
- Fix commit title.
- Add Fixes tag.
- Add more comments inline.
- Rebase on latest next.
- Link to v3: https://lore.kernel.org/r/20240809-ak09918-v3-0-6b036db4d5ec@mainlining.org

Changes in v3:
- Relax failure on unknown device id
for support more register compatible variants.
- Change to fallback compatible.
- Make ST2 to be always read after measuremnt read.
- Reword fix commit with more explanation.
- Link to v2: https://lore.kernel.org/r/20240806-ak09918-v2-0-c300da66c198@mainlining.org

Changes in v2:
- Remove unnecessary ak09918 compatbile.
- Link to v1: https://lore.kernel.org/r/20240805-ak09918-v1-0-70837eebd7d8@mainlining.org

---
Barnabás Czémán (2):
      iio: magnetometer: ak8975: Relax failure on unknown id
      iio: magnetometer: ak8975: Fix reading for ak099xx sensors

Danila Tikhonov (2):
      dt-bindings: iio: magnetometer: Add ak09118
      iio: magnetometer: ak8975: Add AK09118 support

 .../iio/magnetometer/asahi-kasei,ak8975.yaml       |  4 ++
 drivers/iio/magnetometer/Kconfig                   |  2 +-
 drivers/iio/magnetometer/ak8975.c                  | 78 ++++++++++++++++------
 3 files changed, 64 insertions(+), 20 deletions(-)
---
base-commit: 367b5c3d53e57d51a5878816804652963da90950
change-id: 20240805-ak09918-4a6cfef91c32

Best regards,
-- 
Barnabás Czémán <barnabas.czeman@mainlining.org>

[PATCH v4 1/4] iio: magnetometer: ak8975: Relax failure on unknown id

[Barnabás Czémán]

Relax failure when driver gets an unknown device id for
allow probe for register compatible devices.

Signed-off-by: Barnabás Czémán <barnabas.czeman@mainlining.org>
---
 drivers/iio/magnetometer/ak8975.c | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/drivers/iio/magnetometer/ak8975.c b/drivers/iio/magnetometer/ak8975.c
index ccbebe5b66cd..8eef4d5dd9e2 100644
--- a/drivers/iio/magnetometer/ak8975.c
+++ b/drivers/iio/magnetometer/ak8975.c
@@ -484,10 +484,13 @@ static int ak8975_who_i_am(struct i2c_client *client,
 		if (wia_val[1] == AK09916_DEVICE_ID)
 			return 0;
 		break;
-	default:
-		dev_err(&client->dev, "Type %d unknown\n", type);
 	}
-	return -ENODEV;
+
+	dev_info(&client->dev, "Device ID %x is unknown.\n", wia_val[1]);
+	/* Let driver to probe on unknown id for support more register
+	 * compatible variants.
+	 */
+	return 0;
 }
 
 /*

-- 
2.46.0

Re: [PATCH v4 1/4] iio: magnetometer: ak8975: Relax failure on unknown id

[Jonathan Cameron]

On Mon, 19 Aug 2024 00:29:39 +0200
Barnabás Czémán <barnabas.czeman@mainlining.org> wrote:

> Relax failure when driver gets an unknown device id for
> allow probe for register compatible devices.
> 
> Signed-off-by: Barnabás Czémán <barnabas.czeman@mainlining.org>
> ---
>  drivers/iio/magnetometer/ak8975.c | 9 ++++++---
>  1 file changed, 6 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/iio/magnetometer/ak8975.c b/drivers/iio/magnetometer/ak8975.c
> index ccbebe5b66cd..8eef4d5dd9e2 100644
> --- a/drivers/iio/magnetometer/ak8975.c
> +++ b/drivers/iio/magnetometer/ak8975.c
> @@ -484,10 +484,13 @@ static int ak8975_who_i_am(struct i2c_client *client,
>  		if (wia_val[1] == AK09916_DEVICE_ID)
>  			return 0;
>  		break;
> -	default:
> -		dev_err(&client->dev, "Type %d unknown\n", type);
>  	}
> -	return -ENODEV;
> +
> +	dev_info(&client->dev, "Device ID %x is unknown.\n", wia_val[1]);
> +	/* Let driver to probe on unknown id for support more register
Comment style wrong, I'll fix it up.

With that tweak applied to the togreg branch of iio.git

Thanks,

Jonathan


> +	 * compatible variants.
> +	 */
> +	return 0;
>  }
>  
>  /*
> 

Re: [PATCH v4 1/4] iio: magnetometer: ak8975: Relax failure on unknown id

[Andy Shevchenko]

On Fri, Aug 23, 2024 at 07:32:03PM +0100, Jonathan Cameron wrote:
> On Mon, 19 Aug 2024 00:29:39 +0200
> Barnabás Czémán <barnabas.czeman@mainlining.org> wrote:

...

> > +	/* Let driver to probe on unknown id for support more register
> Comment style wrong, I'll fix it up.
> 
> With that tweak applied to the togreg branch of iio.git
> 
> Thanks,
> 
> Jonathan
> 
> 
> > +	 * compatible variants.
> > +	 */

There is another one also wrong.

+	[AK09918] = {
+		/* ak09918 is register compatible with ak09912 this is for avoid
+		 * unknown id messages.
+		 */


-- 
With Best Regards,
Andy Shevchenko

Re: [PATCH v4 1/4] iio: magnetometer: ak8975: Relax failure on unknown id

[Jonathan Cameron]

On Fri, 23 Aug 2024 22:11:15 +0300
Andy Shevchenko <andriy.shevchenko@intel.com> wrote:

> On Fri, Aug 23, 2024 at 07:32:03PM +0100, Jonathan Cameron wrote:
> > On Mon, 19 Aug 2024 00:29:39 +0200
> > Barnabás Czémán <barnabas.czeman@mainlining.org> wrote:  
> 
> ...
> 
> > > +	/* Let driver to probe on unknown id for support more register  
> > Comment style wrong, I'll fix it up.
> > 
> > With that tweak applied to the togreg branch of iio.git
> > 
> > Thanks,
> > 
> > Jonathan
> > 
> >   
> > > +	 * compatible variants.
> > > +	 */  
> 
> There is another one also wrong.
> 
> +	[AK09918] = {
> +		/* ak09918 is register compatible with ak09912 this is for avoid
> +		 * unknown id messages.
> +		 */
> 
> 

I think unrelated to this series, but nice to cleanup.
Patches welcome :) Or it I get bored, I might do a scrub of the full subsystem
to get everything in the same style and not provide incorrect choices to
cut and paste.

Jonathan

Re: [PATCH v4 1/4] iio: magnetometer: ak8975: Relax failure on unknown id

[Andy Shevchenko]

On Mon, Aug 26, 2024 at 11:39:20AM +0100, Jonathan Cameron wrote:
> On Fri, 23 Aug 2024 22:11:15 +0300
> Andy Shevchenko <andriy.shevchenko@intel.com> wrote:
> > On Fri, Aug 23, 2024 at 07:32:03PM +0100, Jonathan Cameron wrote:
> > > On Mon, 19 Aug 2024 00:29:39 +0200
> > > Barnabás Czémán <barnabas.czeman@mainlining.org> wrote:  

...

> > > > +	/* Let driver to probe on unknown id for support more register  
> > > Comment style wrong, I'll fix it up.
> > > 
> > > With that tweak applied to the togreg branch of iio.git

> > > > +	 * compatible variants.
> > > > +	 */  
> > 
> > There is another one also wrong.
> > 
> > +	[AK09918] = {
> > +		/* ak09918 is register compatible with ak09912 this is for avoid
> > +		 * unknown id messages.
> > +		 */
> 
> I think unrelated to this series, but nice to cleanup.
> Patches welcome :)

Sure, but I leave this to newbies to have a material to exercise on.

> Or it I get bored, I might do a scrub of the full subsystem to get everything
> in the same style and not provide incorrect choices to cut and paste.

:-)

I believe we still have more interesting cases, than white space cleanups.

-- 
With Best Regards,
Andy Shevchenko

[PATCH v4 2/4] iio: magnetometer: ak8975: Fix reading for ak099xx sensors

[Barnabás Czémán]

Move ST2 reading with overflow handling after measurement data
reading.
ST2 register read have to be read after read measurment data,
because it means end of the reading and realease the lock on the data.
Remove ST2 read skip on interrupt based waiting because ST2 required to
be read out at and of the axis read.

Fixes: 57e73a423b1e ("iio: ak8975: add ak09911 and ak09912 support")
Signed-off-by: Barnabás Czémán <barnabas.czeman@mainlining.org>
---
 drivers/iio/magnetometer/ak8975.c | 32 ++++++++++++++++----------------
 1 file changed, 16 insertions(+), 16 deletions(-)

diff --git a/drivers/iio/magnetometer/ak8975.c b/drivers/iio/magnetometer/ak8975.c
index 8eef4d5dd9e2..2fa6721aa66f 100644
--- a/drivers/iio/magnetometer/ak8975.c
+++ b/drivers/iio/magnetometer/ak8975.c
@@ -695,22 +695,8 @@ static int ak8975_start_read_axis(struct ak8975_data *data,
 	if (ret < 0)
 		return ret;
 
-	/* This will be executed only for non-interrupt based waiting case */
-	if (ret & data->def->ctrl_masks[ST1_DRDY]) {
-		ret = i2c_smbus_read_byte_data(client,
-					       data->def->ctrl_regs[ST2]);
-		if (ret < 0) {
-			dev_err(&client->dev, "Error in reading ST2\n");
-			return ret;
-		}
-		if (ret & (data->def->ctrl_masks[ST2_DERR] |
-			   data->def->ctrl_masks[ST2_HOFL])) {
-			dev_err(&client->dev, "ST2 status error 0x%x\n", ret);
-			return -EINVAL;
-		}
-	}
-
-	return 0;
+	/* Return with zero if the data is ready. */
+	return !data->def->ctrl_regs[ST1_DRDY];
 }
 
 /* Retrieve raw flux value for one of the x, y, or z axis.  */
@@ -737,6 +723,20 @@ static int ak8975_read_axis(struct iio_dev *indio_dev, int index, int *val)
 	if (ret < 0)
 		goto exit;
 
+	/* Read out ST2 for release lock on measurment data. */
+	ret = i2c_smbus_read_byte_data(client, data->def->ctrl_regs[ST2]);
+	if (ret < 0) {
+		dev_err(&client->dev, "Error in reading ST2\n");
+		goto exit;
+	}
+
+	if (ret & (data->def->ctrl_masks[ST2_DERR] |
+		   data->def->ctrl_masks[ST2_HOFL])) {
+		dev_err(&client->dev, "ST2 status error 0x%x\n", ret);
+		ret = -EINVAL;
+		goto exit;
+	}
+
 	mutex_unlock(&data->lock);
 
 	pm_runtime_mark_last_busy(&data->client->dev);

-- 
2.46.0

[PATCH v4 3/4] dt-bindings: iio: magnetometer: Add ak09118

[Barnabás Czémán]

From: Danila Tikhonov <danila@jiaxyga.com>

Document asahi-kasei,ak09918 compatible as a fallback compatible,
ak09918 is register compatible with ak09912.

Signed-off-by: Danila Tikhonov <danila@jiaxyga.com>
Signed-off-by: Barnabás Czémán <barnabas.czeman@mainlining.org>
---
 .../devicetree/bindings/iio/magnetometer/asahi-kasei,ak8975.yaml      | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/Documentation/devicetree/bindings/iio/magnetometer/asahi-kasei,ak8975.yaml b/Documentation/devicetree/bindings/iio/magnetometer/asahi-kasei,ak8975.yaml
index fe5145d3b73c..e8ca9a234027 100644
--- a/Documentation/devicetree/bindings/iio/magnetometer/asahi-kasei,ak8975.yaml
+++ b/Documentation/devicetree/bindings/iio/magnetometer/asahi-kasei,ak8975.yaml
@@ -18,6 +18,10 @@ properties:
           - asahi-kasei,ak09911
           - asahi-kasei,ak09912
           - asahi-kasei,ak09916
+      - items:
+          # ak09918 is register compatible with ak09912.
+          - const: asahi-kasei,ak09918
+          - const: asahi-kasei,ak09912
       - enum:
           - ak8975
           - ak8963

-- 
2.46.0

Re: [PATCH v4 3/4] dt-bindings: iio: magnetometer: Add ak09118

[Conor Dooley]

[-- Attachment #1: Type: text/plain, Size: 414 bytes --]

On Mon, Aug 19, 2024 at 12:29:41AM +0200, Barnabás Czémán wrote:
> From: Danila Tikhonov <danila@jiaxyga.com>
> 
> Document asahi-kasei,ak09918 compatible as a fallback compatible,
> ak09918 is register compatible with ak09912.
> 
> Signed-off-by: Danila Tikhonov <danila@jiaxyga.com>
> Signed-off-by: Barnabás Czémán <barnabas.czeman@mainlining.org>

Acked-by: Conor Dooley <conor.dooley@microchip.com>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

[PATCH v4 4/4] iio: magnetometer: ak8975: Add AK09118 support

[Barnabás Czémán]

From: Danila Tikhonov <danila@jiaxyga.com>

Add additional AK09118 to the magnetometer driver which has the same
register mapping and scaling as the AK09112 device.

Signed-off-by: Danila Tikhonov <danila@jiaxyga.com>
Acked-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Signed-off-by: Barnabás Czémán <barnabas.czeman@mainlining.org>
---
 drivers/iio/magnetometer/Kconfig  |  2 +-
 drivers/iio/magnetometer/ak8975.c | 37 +++++++++++++++++++++++++++++++++++++
 2 files changed, 38 insertions(+), 1 deletion(-)

diff --git a/drivers/iio/magnetometer/Kconfig b/drivers/iio/magnetometer/Kconfig
index cd2917d71904..8eb718f5e50f 100644
--- a/drivers/iio/magnetometer/Kconfig
+++ b/drivers/iio/magnetometer/Kconfig
@@ -39,7 +39,7 @@ config AK8975
 	select IIO_TRIGGERED_BUFFER
 	help
 	  Say yes here to build support for Asahi Kasei AK8975, AK8963,
-	  AK09911, AK09912 or AK09916 3-Axis Magnetometer.
+	  AK09911, AK09912, AK09916 or AK09918 3-Axis Magnetometer.
 
 	  To compile this driver as a module, choose M here: the module
 	  will be called ak8975.
diff --git a/drivers/iio/magnetometer/ak8975.c b/drivers/iio/magnetometer/ak8975.c
index 2fa6721aa66f..0eb0da9d6787 100644
--- a/drivers/iio/magnetometer/ak8975.c
+++ b/drivers/iio/magnetometer/ak8975.c
@@ -78,6 +78,7 @@
  */
 #define AK09912_REG_WIA1		0x00
 #define AK09912_REG_WIA2		0x01
+#define AK09918_DEVICE_ID		0x0C
 #define AK09916_DEVICE_ID		0x09
 #define AK09912_DEVICE_ID		0x04
 #define AK09911_DEVICE_ID		0x05
@@ -209,6 +210,7 @@ enum asahi_compass_chipset {
 	AK09911,
 	AK09912,
 	AK09916,
+	AK09918,
 };
 
 enum ak_ctrl_reg_addr {
@@ -371,6 +373,34 @@ static const struct ak_def ak_def_array[] = {
 			AK09912_REG_HXL,
 			AK09912_REG_HYL,
 			AK09912_REG_HZL},
+	},
+	[AK09918] = {
+		/* ak09918 is register compatible with ak09912 this is for avoid
+		 * unknown id messages.
+		 */
+		.type = AK09918,
+		.raw_to_gauss = ak09912_raw_to_gauss,
+		.range = 32752,
+		.ctrl_regs = {
+			AK09912_REG_ST1,
+			AK09912_REG_ST2,
+			AK09912_REG_CNTL2,
+			AK09912_REG_ASAX,
+			AK09912_MAX_REGS},
+		.ctrl_masks = {
+			AK09912_REG_ST1_DRDY_MASK,
+			AK09912_REG_ST2_HOFL_MASK,
+			0,
+			AK09912_REG_CNTL2_MODE_MASK},
+		.ctrl_modes = {
+			AK09912_REG_CNTL_MODE_POWER_DOWN,
+			AK09912_REG_CNTL_MODE_ONCE,
+			AK09912_REG_CNTL_MODE_SELF_TEST,
+			AK09912_REG_CNTL_MODE_FUSE_ROM},
+		.data_regs = {
+			AK09912_REG_HXL,
+			AK09912_REG_HYL,
+			AK09912_REG_HZL},
 	}
 };
 
@@ -452,6 +482,7 @@ static int ak8975_who_i_am(struct i2c_client *client,
 	/*
 	 * Signature for each device:
 	 * Device   |  WIA1      |  WIA2
+	 * AK09918  |  DEVICE_ID_|  AK09918_DEVICE_ID
 	 * AK09916  |  DEVICE_ID_|  AK09916_DEVICE_ID
 	 * AK09912  |  DEVICE_ID |  AK09912_DEVICE_ID
 	 * AK09911  |  DEVICE_ID |  AK09911_DEVICE_ID
@@ -484,6 +515,10 @@ static int ak8975_who_i_am(struct i2c_client *client,
 		if (wia_val[1] == AK09916_DEVICE_ID)
 			return 0;
 		break;
+	case AK09918:
+		if (wia_val[1] == AK09918_DEVICE_ID)
+			return 0;
+		break;
 	}
 
 	dev_info(&client->dev, "Device ID %x is unknown.\n", wia_val[1]);
@@ -1070,6 +1105,7 @@ static const struct i2c_device_id ak8975_id[] = {
 	{"ak09911", (kernel_ulong_t)&ak_def_array[AK09911] },
 	{"ak09912", (kernel_ulong_t)&ak_def_array[AK09912] },
 	{"ak09916", (kernel_ulong_t)&ak_def_array[AK09916] },
+	{"ak09918", (kernel_ulong_t)&ak_def_array[AK09918] },
 	{}
 };
 MODULE_DEVICE_TABLE(i2c, ak8975_id);
@@ -1084,6 +1120,7 @@ static const struct of_device_id ak8975_of_match[] = {
 	{ .compatible = "asahi-kasei,ak09912", .data = &ak_def_array[AK09912] },
 	{ .compatible = "ak09912", .data = &ak_def_array[AK09912] },
 	{ .compatible = "asahi-kasei,ak09916", .data = &ak_def_array[AK09916] },
+	{ .compatible = "asahi-kasei,ak09918", .data = &ak_def_array[AK09918] },
 	{}
 };
 MODULE_DEVICE_TABLE(of, ak8975_of_match);

-- 
2.46.0

Re: [PATCH v4 4/4] iio: magnetometer: ak8975: Add AK09118 support

[Jonathan Cameron]

On Mon, 19 Aug 2024 00:29:42 +0200
Barnabás Czémán <barnabas.czeman@mainlining.org> wrote:

> From: Danila Tikhonov <danila@jiaxyga.com>
> 
> Add additional AK09118 to the magnetometer driver which has the same
> register mapping and scaling as the AK09112 device.
> 
> Signed-off-by: Danila Tikhonov <danila@jiaxyga.com>
> Acked-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
> Signed-off-by: Barnabás Czémán <barnabas.czeman@mainlining.org>
Applied rest of series to the testing branch of iio.git.
I'll rebase that after the pull I have outstanding is in Greg's
tree and then it will become togreg and get picked up by linux-next
etc.

Thanks,

Jonathan