[PATCH 4/4] iio: magnetometer: ak8975: modernize polling loops with iopoll() macros

Joshua Crofts
2026-04-20T11:09:10Z

The driver currently uses while loops and msleep() for polling during
conversion waits.

Replace the custom polling loops with readx_poll_timeout() and
read_poll_timeout() macros from <linux/iopoll.h>. This reduces
boilerplate, standardizes timeout handling and improves overall code
readability, keeping the original timing and error behaviour.

Assisted-by: Gemini:3.1-Pro
Signed-off-by: Joshua Crofts <joshua.crofts1@gmail.com>
---
drivers/iio/magnetometer/ak8975.c | 44 ++++++++++++++-----------------
1 file changed, 20 insertions(+), 24 deletions(-)

diff --git a/drivers/iio/magnetometer/ak8975.c b/drivers/iio/magnetometer/ak8975.c
index c57ff6d99f3..86b4149e77b 100644
--- a/drivers/iio/magnetometer/ak8975.c
+++ b/drivers/iio/magnetometer/ak8975.c
@@ -15,6 +15,7 @@
#include <linux/gpio/consumer.h>
#include <linux/i2c.h>
#include <linux/interrupt.h>
+#include <linux/iopoll.h>
#include <linux/irqreturn.h>
#include <linux/minmax.h>
#include <linux/mod_devicetable.h>
@@ -651,17 +652,15 @@ static int ak8975_setup(struct i2c_client *client)
static int wait_conversion_complete_gpio(struct ak8975_data *data)
{
struct i2c_client *client = data->client;
- u32 timeout_ms = AK8975_MAX_CONVERSION_TIMEOUT;
int ret;
+ int val;

/* Wait for the conversion to complete. */
- while (timeout_ms) {
- msleep(AK8975_CONVERSION_DONE_POLL_TIME);
- if (gpiod_get_value(data->eoc_gpiod))
- break;
- timeout_ms -= AK8975_CONVERSION_DONE_POLL_TIME;
- }
- if (!timeout_ms) {
+ ret = readx_poll_timeout(gpiod_get_value, data->eoc_gpiod, val, val != 0,
+ AK8975_CONVERSION_DONE_POLL_TIME * 1000,
+ AK8975_MAX_CONVERSION_TIMEOUT * 1000);
+
+ if (ret) {
dev_err(&client->dev, "Conversion timeout happened\n");
return -EINVAL;
}
@@ -676,30 +675,27 @@ static int wait_conversion_complete_gpio(struct ak8975_data *data)
static int wait_conversion_complete_polled(struct ak8975_data *data)
{
struct i2c_client *client = data->client;
- u8 read_status;
- u32 timeout_ms = AK8975_MAX_CONVERSION_TIMEOUT;
int ret;
+ int val;

/* Wait for the conversion to complete. */
- while (timeout_ms) {
- msleep(AK8975_CONVERSION_DONE_POLL_TIME);
- ret = i2c_smbus_read_byte_data(client,
- data->def->ctrl_regs[ST1]);
- if (ret < 0) {
- dev_err(&client->dev, "Error in reading ST1\n");
- return ret;
- }
- read_status = ret;
- if (read_status)
- break;
- timeout_ms -= AK8975_CONVERSION_DONE_POLL_TIME;
+ ret = read_poll_timeout(i2c_smbus_read_byte_data, val, val != 0,
+ AK8975_CONVERSION_DONE_POLL_TIME * 1000,
+ AK8975_MAX_CONVERSION_TIMEOUT * 1000,
+ true,
+ client, data->def->ctrl_regs[ST1]);
+
+ if (val < 0) {
+ dev_err(&client->dev, "Error in reading ST1\n");
+ return val;
}
- if (!timeout_ms) {
+
+ if (ret == -ETIMEDOUT) {
dev_err(&client->dev, "Conversion timeout happened\n");
return -EINVAL;
}

- return read_status;
+ return val;
}

/* Returns 0 if the end of conversion interrupt occurred or -ETIME otherwise */
--
2.47.3