This series is working towards moving the ad2s1210 resolver driver out of
staging (after 13 years!). It involves a bunch of fixes and improvements
to make proper device tree bindings and use standard IIO sysfs attributes.
This series has been tested on actual hardware using a EVAL-AD2S1210 evaluation
board. (Note: not all device tree features have been implemented in the driver
since the eval board doesn't support them out of the box. We plan to add them
later if needed.)
---
v5 changes:
* Dropped applied patches:
* "staging: iio: resolver: ad2s1210: do not use fault register for dummy read"
* "staging: iio: resolver: ad2s1210: implement hysteresis as channel attr"
* "staging: iio: resolver: ad2s1210: convert fexcit to channel attribute"
* "staging: iio: resolver: ad2s1210: convert resolution to devicetree property"
* "staging: iio: resolver: ad2s1210: add phase lock range support"
* "staging: iio: resolver: ad2s1210: add triggered buffer support"
* "staging: iio: resolver: ad2s1210: convert LOT threshold attrs to event attrs"
* "staging: iio: resolver: ad2s1210: convert LOS threshold to event attr"
* "staging: iio: resolver: ad2s1210: convert DOS overrange threshold to event attr"
* "staging: iio: resolver: ad2s1210: convert DOS mismatch threshold to event attr"
* "staging: iio: resolver: ad2s1210: rename DOS reset min/max attrs"
* "iio: event: add optional event label support"
* "staging: iio: resolver: ad2s1210: implement fault events"
* "staging: iio: resolver: ad2s1210: add register/fault support summary"
* "staging: iio: resolver: ad2s1210: add label attribute support"
* "staging: iio: resolver: ad2s1210: remove fault attribute"
* Added new patches:
* "staging: iio: resolver: ad2s1210: refactor sample toggle"
* "staging: iio: resolver: ad2s1210: clear faults after soft reset"
* "iio: resolver: ad2s1210: move out of staging"
Link to v4: https://lore.kernel.org/r/[email protected]
v4 changes:
* Dropped applied patches:
* "dt-bindings: iio: resolver: add devicetree bindings for ad2s1210"
* "staging: iio: resolver: ad2s1210: read excitation frequency from
control register"
* "staging: iio: resolver: ad2s1210: refactor setting excitation
frequency"
* "staging: iio: resolver: ad2s1210: rework gpios"
* "staging: iio: resolver: ad2s1210: remove config attribute"
* "staging: iio: resolver: ad2s1210: add debugfs reg access"
* "staging: iio: resolver: ad2s1210: use regmap for config registers"
* "staging: iio: resolver: ad2s1210: use devicetree to get CLKIN rate"
* "staging: iio: resolver: ad2s1210: implement IIO_CHAN_INFO_SCALE"
* "staging: iio: resolver: ad2s1210: always use 16-bit value for raw
read"
* "staging: iio: resolver: ad2s1210: sort imports"
* "staging: iio: resolver: ad2s1210: remove spi_set_drvdata()"
* "staging: iio: resolver: ad2s1210: check return of ad2s1210_initial()"
* "staging: iio: resolver: ad2s1210: remove call to spi_setup()"
* "staging: iio: resolver: ad2s1210: fix use before initialization"
* Added new patches:
* "staging: iio: resolver: ad2s1210: do not use fault register for
dummy read"
* "iio: event: add optional event label support"
* "staging: iio: resolver: ad2s1210: add register/fault support summary"
* "staging: iio: resolver: ad2s1210: remove fault attribute"
* "staging: iio: resolver: ad2s1210: simplify code with guard(mutex)"
* Fixed DT property name in commit description of "staging: iio:
resolver: ad2s1210: convert resolution to devicetree property"
* Fixed compile error in "staging: iio: resolver: ad2s1210: implement
fault events".
* Fixed angl0 hysteresis raw values when assigned-resolution-bits != 16.
* Fixed missing word in "staging: iio: resolver: ad2s1210: convert DOS
overrange threshold to event attr" commit description.
* Fixed missing static qualifier on event attribute definitions.
* Dropped used of X/Y modifiers on sine/cosine channels.
* Changed type/direction on some events.
* Added event *_label attributes.
Link to v3: https://lore.kernel.org/r/[email protected]
v3 changes:
* Dropped applied patches:
* "staging: iio: resolver: ad2s1210: fix ad2s1210_show_fault"
* "staging: iio: resolver: ad2s1210: fix not restoring sample gpio in
channel read"
* Dropped "staging: iio: Documentation: document IIO resolver AD2S1210
sysfs attributes". We will attempt to use existing ABI for faults/
thresholds in a future series.
* Added description of A0/A1 lines in DT bindings.
* Added power supply regulators to DT bindings.
* Moved sorting imports to separate patch.
* Renamed fclkin to clkin_hz.
* Added __be16 sample field to state struct for reading raw samples.
* Split out new function ad2s1210_single_conversion() from
ad2s1210_read_raw().
* Split out new ad2s1210_get_hysteresis() and ad2s1210_set_hysteresis()
functions.
* Fixed multi-line comment style.
* Added notes about soft reset not resetting config registers.
* Made use of FIELD_PREP() macro.
* Added more explanation to regmap commit message.
* Removed datasheet names from channel specs.
* Replaced "staging: iio: resolver: ad2s1210: rename fexcit attribute"
with "staging: iio: resolver: ad2s1210: convert fexcit to channel
attribute".
* Replaced "staging: iio: resolver: ad2s1210: add phase_lock_range
attributes" with "staging: iio: resolver: ad2s1210: add phase lock
range support"
* Added additional patches to convert custom device attributes to event
attributes.
* Added patch for to add label attributes.
Link to v2: https://lore.kernel.org/r/[email protected]
v2 changes:
* Address initial device tree patch feedback
* Drop "iio: sysfs: add IIO_DEVICE_ATTR_NAMED_RW macro" (related cleanups
also dropped for now, will address in a future series if needed)
* Apply improvements as a series of patches to the staging driver. It is
not quite ready for the move out of staging patch yet.
---
David Lechner (4):
staging: iio: resolver: ad2s1210: refactor sample toggle
staging: iio: resolver: ad2s1210: clear faults after soft reset
staging: iio: resolver: ad2s1210: simplify code with guard(mutex)
iio: resolver: ad2s1210: move out of staging
.../ABI/testing}/sysfs-bus-iio-resolver-ad2s1210 | 0
drivers/iio/resolver/Kconfig | 13 ++
drivers/iio/resolver/Makefile | 1 +
drivers/{staging => }/iio/resolver/ad2s1210.c | 208 ++++++++++-----------
drivers/staging/iio/Kconfig | 1 -
drivers/staging/iio/Makefile | 1 -
drivers/staging/iio/resolver/Kconfig | 19 --
drivers/staging/iio/resolver/Makefile | 6 -
8 files changed, 109 insertions(+), 140 deletions(-)
---
base-commit: 57fd97ead0e87ca528736f1945a3ba3096de2f3e
change-id: 20230925-ad2s1210-mainline-2791ef75e386
Best regards,
--
David Lechner <[email protected]>
This refactors the sample line toggle in the ad2s1210 resolver driver
to a separate function. The sample has some timing requirements, so
this ensures that it is always done the same way, both in the existing
call sites and any future usage.
Previously, the sample line was kept on for the duration of the read,
but this is not necessary. Data is latched in on the rising edge and
after the specified delay the state of the sample line does not matter.
Signed-off-by: David Lechner <[email protected]>
---
v5 changes: New patch in v5.
drivers/staging/iio/resolver/ad2s1210.c | 30 ++++++++++++++++++++++--------
1 file changed, 22 insertions(+), 8 deletions(-)
diff --git a/drivers/staging/iio/resolver/ad2s1210.c b/drivers/staging/iio/resolver/ad2s1210.c
index e0bea3c68664..59c273a4b6a9 100644
--- a/drivers/staging/iio/resolver/ad2s1210.c
+++ b/drivers/staging/iio/resolver/ad2s1210.c
@@ -286,6 +286,26 @@ static int ad2s1210_regmap_reg_read(void *context, unsigned int reg,
return 0;
}
+/*
+ * Toggles the SAMPLE line on the AD2S1210 to latch in the current position,
+ * velocity, and faults.
+ *
+ * Must be called with lock held.
+ */
+static void ad2s1210_toggle_sample_line(struct ad2s1210_state *st)
+{
+ /*
+ * Datasheet specifies minimum hold time t16 = 2 * tck + 20 ns. So the
+ * longest time needed is when CLKIN is 6.144 MHz, in which case t16
+ * ~= 350 ns. The same delay is also needed before re-asserting the
+ * SAMPLE line.
+ */
+ gpiod_set_value(st->sample_gpio, 1);
+ ndelay(350);
+ gpiod_set_value(st->sample_gpio, 0);
+ ndelay(350);
+}
+
/*
* Sets the excitation frequency and performs software reset.
*
@@ -405,10 +425,8 @@ static int ad2s1210_single_conversion(struct iio_dev *indio_dev,
int ret;
mutex_lock(&st->lock);
- gpiod_set_value(st->sample_gpio, 1);
+ ad2s1210_toggle_sample_line(st);
timestamp = iio_get_time_ns(indio_dev);
- /* delay (6 * tck + 20) nano seconds */
- udelay(1);
switch (chan->type) {
case IIO_ANGL:
@@ -444,9 +462,6 @@ static int ad2s1210_single_conversion(struct iio_dev *indio_dev,
ad2s1210_push_events(indio_dev, st->sample.fault, timestamp);
error_ret:
- gpiod_set_value(st->sample_gpio, 0);
- /* delay (2 * tck + 20) nano seconds */
- udelay(1);
mutex_unlock(&st->lock);
return ret;
}
@@ -1268,7 +1283,7 @@ static irqreturn_t ad2s1210_trigger_handler(int irq, void *p)
mutex_lock(&st->lock);
memset(&st->scan, 0, sizeof(st->scan));
- gpiod_set_value(st->sample_gpio, 1);
+ ad2s1210_toggle_sample_line(st);
if (test_bit(0, indio_dev->active_scan_mask)) {
ret = ad2s1210_set_mode(st, MOD_POS);
@@ -1298,7 +1313,6 @@ static irqreturn_t ad2s1210_trigger_handler(int irq, void *p)
iio_push_to_buffers_with_timestamp(indio_dev, &st->scan, pf->timestamp);
error_ret:
- gpiod_set_value(st->sample_gpio, 0);
mutex_unlock(&st->lock);
iio_trigger_notify_done(indio_dev->trig);
--
2.42.0
When a software reset is performed on the AD2S1210 to make the selected
excitation frequency take effect, it always triggers faults on the
input signals because the output signal is interrupted momentarily.
So we need to clear the faults after the software reset to avoid
triggering fault events the next time a sample is read.
The datasheet specifies a time t[track] in Table 27 that specifies the
settle time in milliseconds after a reset depending on the selected
resolution. This is used in the driver to add an appropriate delay.
Signed-off-by: David Lechner <[email protected]>
---
v5 changes: New patch in v5.
drivers/staging/iio/resolver/ad2s1210.c | 25 ++++++++++++++++++++++++-
1 file changed, 24 insertions(+), 1 deletion(-)
diff --git a/drivers/staging/iio/resolver/ad2s1210.c b/drivers/staging/iio/resolver/ad2s1210.c
index 59c273a4b6a9..cf4018434447 100644
--- a/drivers/staging/iio/resolver/ad2s1210.c
+++ b/drivers/staging/iio/resolver/ad2s1210.c
@@ -314,6 +314,9 @@ static void ad2s1210_toggle_sample_line(struct ad2s1210_state *st)
static int ad2s1210_reinit_excitation_frequency(struct ad2s1210_state *st,
u16 fexcit)
{
+ /* Map resolution to settle time in milliseconds. */
+ static const int track_time_ms[] = { 10, 20, 25, 60 };
+ unsigned int ignored;
int ret;
u8 fcw;
@@ -329,7 +332,27 @@ static int ad2s1210_reinit_excitation_frequency(struct ad2s1210_state *st,
* Software reset reinitializes the excitation frequency output.
* It does not reset any of the configuration registers.
*/
- return regmap_write(st->regmap, AD2S1210_REG_SOFT_RESET, 0);
+ ret = regmap_write(st->regmap, AD2S1210_REG_SOFT_RESET, 0);
+ if (ret < 0)
+ return ret;
+
+ /*
+ * Soft reset always triggers some faults due the change in the output
+ * signal so clear the faults too. We need to delay for some time
+ * (what datasheet calls t[track]) to allow things to settle before
+ * clearing the faults.
+ */
+ msleep(track_time_ms[st->resolution] * 8192000 / st->clkin_hz);
+
+ /* Reading the fault register clears the faults. */
+ ret = regmap_read(st->regmap, AD2S1210_REG_FAULT, &ignored);
+ if (ret < 0)
+ return ret;
+
+ /* Have to toggle sample line to get fault output pins to reset. */
+ ad2s1210_toggle_sample_line(st);
+
+ return 0;
}
static void ad2s1210_push_events(struct iio_dev *indio_dev,
--
2.42.0
We can simplify the code and get rid of most of the gotos by using
guard(mutex) from cleanup.h.
Signed-off-by: David Lechner <[email protected]>
---
v5 changes: None (rebased).
Review comment from v4 is no longer applicable as it was addressed in
"staging: iio: resolver: ad2s1210: refactor sample toggle"
drivers/staging/iio/resolver/ad2s1210.c | 153 ++++++++++----------------------
1 file changed, 49 insertions(+), 104 deletions(-)
diff --git a/drivers/staging/iio/resolver/ad2s1210.c b/drivers/staging/iio/resolver/ad2s1210.c
index cf4018434447..bd4a90c222b5 100644
--- a/drivers/staging/iio/resolver/ad2s1210.c
+++ b/drivers/staging/iio/resolver/ad2s1210.c
@@ -47,6 +47,7 @@
#include <linux/bitfield.h>
#include <linux/bits.h>
+#include <linux/cleanup.h>
#include <linux/clk.h>
#include <linux/delay.h>
#include <linux/device.h>
@@ -447,7 +448,8 @@ static int ad2s1210_single_conversion(struct iio_dev *indio_dev,
s64 timestamp;
int ret;
- mutex_lock(&st->lock);
+ guard(mutex)(&st->lock);
+
ad2s1210_toggle_sample_line(st);
timestamp = iio_get_time_ns(indio_dev);
@@ -459,14 +461,13 @@ static int ad2s1210_single_conversion(struct iio_dev *indio_dev,
ret = ad2s1210_set_mode(st, MOD_VEL);
break;
default:
- ret = -EINVAL;
- break;
+ return -EINVAL;
}
if (ret < 0)
- goto error_ret;
+ return ret;
ret = spi_read(st->sdev, &st->sample, 3);
if (ret < 0)
- goto error_ret;
+ return ret;
switch (chan->type) {
case IIO_ANGL:
@@ -478,14 +479,11 @@ static int ad2s1210_single_conversion(struct iio_dev *indio_dev,
ret = IIO_VAL_INT;
break;
default:
- ret = -EINVAL;
- break;
+ return -EINVAL;
}
ad2s1210_push_events(indio_dev, st->sample.fault, timestamp);
-error_ret:
- mutex_unlock(&st->lock);
return ret;
}
@@ -493,11 +491,9 @@ static int ad2s1210_get_hysteresis(struct ad2s1210_state *st, int *val)
{
int ret;
- mutex_lock(&st->lock);
+ guard(mutex)(&st->lock);
ret = regmap_test_bits(st->regmap, AD2S1210_REG_CONTROL,
AD2S1210_ENABLE_HYSTERESIS);
- mutex_unlock(&st->lock);
-
if (ret < 0)
return ret;
@@ -507,15 +503,10 @@ static int ad2s1210_get_hysteresis(struct ad2s1210_state *st, int *val)
static int ad2s1210_set_hysteresis(struct ad2s1210_state *st, int val)
{
- int ret;
-
- mutex_lock(&st->lock);
- ret = regmap_update_bits(st->regmap, AD2S1210_REG_CONTROL,
- AD2S1210_ENABLE_HYSTERESIS,
- val ? AD2S1210_ENABLE_HYSTERESIS : 0);
- mutex_unlock(&st->lock);
-
- return ret;
+ guard(mutex)(&st->lock);
+ return regmap_update_bits(st->regmap, AD2S1210_REG_CONTROL,
+ AD2S1210_ENABLE_HYSTERESIS,
+ val ? AD2S1210_ENABLE_HYSTERESIS : 0);
}
static int ad2s1210_get_phase_lock_range(struct ad2s1210_state *st,
@@ -523,11 +514,9 @@ static int ad2s1210_get_phase_lock_range(struct ad2s1210_state *st,
{
int ret;
- mutex_lock(&st->lock);
+ guard(mutex)(&st->lock);
ret = regmap_test_bits(st->regmap, AD2S1210_REG_CONTROL,
AD2S1210_PHASE_LOCK_RANGE_44);
- mutex_unlock(&st->lock);
-
if (ret < 0)
return ret;
@@ -547,7 +536,7 @@ static int ad2s1210_get_phase_lock_range(struct ad2s1210_state *st,
static int ad2s1210_set_phase_lock_range(struct ad2s1210_state *st,
int val, int val2)
{
- int deg, ret;
+ int deg;
/* convert radians to degrees - only two allowable values */
if (val == PHASE_44_DEG_TO_RAD_INT && val2 == PHASE_44_DEG_TO_RAD_MICRO)
@@ -558,12 +547,10 @@ static int ad2s1210_set_phase_lock_range(struct ad2s1210_state *st,
else
return -EINVAL;
- mutex_lock(&st->lock);
- ret = regmap_update_bits(st->regmap, AD2S1210_REG_CONTROL,
- AD2S1210_PHASE_LOCK_RANGE_44,
- deg == 44 ? AD2S1210_PHASE_LOCK_RANGE_44 : 0);
- mutex_unlock(&st->lock);
- return ret;
+ guard(mutex)(&st->lock);
+ return regmap_update_bits(st->regmap, AD2S1210_REG_CONTROL,
+ AD2S1210_PHASE_LOCK_RANGE_44,
+ deg == 44 ? AD2S1210_PHASE_LOCK_RANGE_44 : 0);
}
/* map resolution to microradians/LSB for LOT registers */
@@ -580,10 +567,8 @@ static int ad2s1210_get_voltage_threshold(struct ad2s1210_state *st,
unsigned int reg_val;
int ret;
- mutex_lock(&st->lock);
+ guard(mutex)(&st->lock);
ret = regmap_read(st->regmap, reg, ®_val);
- mutex_unlock(&st->lock);
-
if (ret < 0)
return ret;
@@ -595,15 +580,11 @@ static int ad2s1210_set_voltage_threshold(struct ad2s1210_state *st,
unsigned int reg, int val)
{
unsigned int reg_val;
- int ret;
reg_val = val / THRESHOLD_MILLIVOLT_PER_LSB;
- mutex_lock(&st->lock);
- ret = regmap_write(st->regmap, reg, reg_val);
- mutex_unlock(&st->lock);
-
- return ret;
+ guard(mutex)(&st->lock);
+ return regmap_write(st->regmap, reg, reg_val);
}
static int ad2s1210_get_lot_high_threshold(struct ad2s1210_state *st,
@@ -612,10 +593,8 @@ static int ad2s1210_get_lot_high_threshold(struct ad2s1210_state *st,
unsigned int reg_val;
int ret;
- mutex_lock(&st->lock);
+ guard(mutex)(&st->lock);
ret = regmap_read(st->regmap, AD2S1210_REG_LOT_HIGH_THRD, ®_val);
- mutex_unlock(&st->lock);
-
if (ret < 0)
return ret;
@@ -634,18 +613,18 @@ static int ad2s1210_set_lot_high_threshold(struct ad2s1210_state *st,
if (val != 0)
return -EINVAL;
- mutex_lock(&st->lock);
+ guard(mutex)(&st->lock);
/*
* We need to read both high and low registers first so we can preserve
* the hysteresis.
*/
ret = regmap_read(st->regmap, AD2S1210_REG_LOT_HIGH_THRD, &high_reg_val);
if (ret < 0)
- goto error_ret;
+ return ret;
ret = regmap_read(st->regmap, AD2S1210_REG_LOT_LOW_THRD, &low_reg_val);
if (ret < 0)
- goto error_ret;
+ return ret;
hysteresis = high_reg_val - low_reg_val;
high_reg_val = val2 / ad2s1210_lot_threshold_urad_per_lsb[st->resolution];
@@ -653,14 +632,9 @@ static int ad2s1210_set_lot_high_threshold(struct ad2s1210_state *st,
ret = regmap_write(st->regmap, AD2S1210_REG_LOT_HIGH_THRD, high_reg_val);
if (ret < 0)
- goto error_ret;
-
- ret = regmap_write(st->regmap, AD2S1210_REG_LOT_LOW_THRD, low_reg_val);
-
-error_ret:
- mutex_unlock(&st->lock);
+ return ret;
- return ret;
+ return regmap_write(st->regmap, AD2S1210_REG_LOT_LOW_THRD, low_reg_val);
}
static int ad2s1210_get_lot_low_threshold(struct ad2s1210_state *st,
@@ -669,16 +643,13 @@ static int ad2s1210_get_lot_low_threshold(struct ad2s1210_state *st,
unsigned int high_reg_val, low_reg_val;
int ret;
- mutex_lock(&st->lock);
+ guard(mutex)(&st->lock);
+
ret = regmap_read(st->regmap, AD2S1210_REG_LOT_HIGH_THRD, &high_reg_val);
if (ret < 0)
- goto error_ret;
+ return ret;
ret = regmap_read(st->regmap, AD2S1210_REG_LOT_LOW_THRD, &low_reg_val);
-
-error_ret:
- mutex_unlock(&st->lock);
-
if (ret < 0)
return ret;
@@ -701,18 +672,14 @@ static int ad2s1210_set_lot_low_threshold(struct ad2s1210_state *st,
hysteresis = val2 / ad2s1210_lot_threshold_urad_per_lsb[st->resolution];
- mutex_lock(&st->lock);
+ guard(mutex)(&st->lock);
+
ret = regmap_read(st->regmap, AD2S1210_REG_LOT_HIGH_THRD, ®_val);
if (ret < 0)
- goto error_ret;
+ return ret;
- ret = regmap_write(st->regmap, AD2S1210_REG_LOT_LOW_THRD,
+ return regmap_write(st->regmap, AD2S1210_REG_LOT_LOW_THRD,
reg_val - hysteresis);
-
-error_ret:
- mutex_unlock(&st->lock);
-
- return ret;
}
static int ad2s1210_get_excitation_frequency(struct ad2s1210_state *st, int *val)
@@ -720,31 +687,23 @@ static int ad2s1210_get_excitation_frequency(struct ad2s1210_state *st, int *val
unsigned int reg_val;
int ret;
- mutex_lock(&st->lock);
+ guard(mutex)(&st->lock);
+
ret = regmap_read(st->regmap, AD2S1210_REG_EXCIT_FREQ, ®_val);
if (ret < 0)
- goto error_ret;
+ return ret;
*val = reg_val * st->clkin_hz / (1 << 15);
- ret = IIO_VAL_INT;
-
-error_ret:
- mutex_unlock(&st->lock);
- return ret;
+ return IIO_VAL_INT;
}
static int ad2s1210_set_excitation_frequency(struct ad2s1210_state *st, int val)
{
- int ret;
-
if (val < AD2S1210_MIN_EXCIT || val > AD2S1210_MAX_EXCIT)
return -EINVAL;
- mutex_lock(&st->lock);
- ret = ad2s1210_reinit_excitation_frequency(st, val);
- mutex_unlock(&st->lock);
-
- return ret;
+ guard(mutex)(&st->lock);
+ return ad2s1210_reinit_excitation_frequency(st, val);
}
static const int ad2s1210_velocity_scale[] = {
@@ -1020,10 +979,8 @@ static ssize_t event_attr_voltage_reg_show(struct device *dev,
unsigned int value;
int ret;
- mutex_lock(&st->lock);
+ guard(mutex)(&st->lock);
ret = regmap_read(st->regmap, iattr->address, &value);
- mutex_unlock(&st->lock);
-
if (ret < 0)
return ret;
@@ -1043,11 +1000,9 @@ static ssize_t event_attr_voltage_reg_store(struct device *dev,
if (ret)
return -EINVAL;
- mutex_lock(&st->lock);
+ guard(mutex)(&st->lock);
ret = regmap_write(st->regmap, iattr->address,
data / THRESHOLD_MILLIVOLT_PER_LSB);
- mutex_unlock(&st->lock);
-
if (ret < 0)
return ret;
@@ -1121,7 +1076,7 @@ static int ad2s1210_initial(struct ad2s1210_state *st)
unsigned int data;
int ret;
- mutex_lock(&st->lock);
+ guard(mutex)(&st->lock);
/* Use default config register value plus resolution from devicetree. */
data = FIELD_PREP(AD2S1210_PHASE_LOCK_RANGE_44, 1);
@@ -1131,13 +1086,9 @@ static int ad2s1210_initial(struct ad2s1210_state *st)
ret = regmap_write(st->regmap, AD2S1210_REG_CONTROL, data);
if (ret < 0)
- goto error_ret;
-
- ret = ad2s1210_reinit_excitation_frequency(st, AD2S1210_DEF_EXCIT);
+ return ret;
-error_ret:
- mutex_unlock(&st->lock);
- return ret;
+ return ad2s1210_reinit_excitation_frequency(st, AD2S1210_DEF_EXCIT);
}
static int ad2s1210_read_label(struct iio_dev *indio_dev,
@@ -1281,18 +1232,13 @@ static int ad2s1210_debugfs_reg_access(struct iio_dev *indio_dev,
unsigned int *readval)
{
struct ad2s1210_state *st = iio_priv(indio_dev);
- int ret;
- mutex_lock(&st->lock);
+ guard(mutex)(&st->lock);
if (readval)
- ret = regmap_read(st->regmap, reg, readval);
- else
- ret = regmap_write(st->regmap, reg, writeval);
-
- mutex_unlock(&st->lock);
+ return regmap_read(st->regmap, reg, readval);
- return ret;
+ return regmap_write(st->regmap, reg, writeval);
}
static irqreturn_t ad2s1210_trigger_handler(int irq, void *p)
@@ -1303,7 +1249,7 @@ static irqreturn_t ad2s1210_trigger_handler(int irq, void *p)
size_t chan = 0;
int ret;
- mutex_lock(&st->lock);
+ guard(mutex)(&st->lock);
memset(&st->scan, 0, sizeof(st->scan));
ad2s1210_toggle_sample_line(st);
@@ -1336,7 +1282,6 @@ static irqreturn_t ad2s1210_trigger_handler(int irq, void *p)
iio_push_to_buffers_with_timestamp(indio_dev, &st->scan, pf->timestamp);
error_ret:
- mutex_unlock(&st->lock);
iio_trigger_notify_done(indio_dev->trig);
return IRQ_HANDLED;
--
2.42.0
This moves the ad2s1210 resolver driver out of staging. The driver has
been fixed up and is ready to graduate.
Signed-off-by: David Lechner <[email protected]>
---
v5 changes: New patch in v5.
Diff was made with file rename detection turned off so we can see the full
driver code for one last check through. sysfs-bus-iio-resolver-ad2s1210 and
ad2s1210.c are just moved (no changes).
.../testing/sysfs-bus-iio-resolver-ad2s1210 | 27 +
drivers/iio/resolver/Kconfig | 13 +
drivers/iio/resolver/Makefile | 1 +
drivers/iio/resolver/ad2s1210.c | 1522 +++++++++++++++++
.../sysfs-bus-iio-resolver-ad2s1210 | 27 -
drivers/staging/iio/Kconfig | 1 -
drivers/staging/iio/Makefile | 1 -
drivers/staging/iio/resolver/Kconfig | 19 -
drivers/staging/iio/resolver/Makefile | 6 -
drivers/staging/iio/resolver/ad2s1210.c | 1522 -----------------
10 files changed, 1563 insertions(+), 1576 deletions(-)
create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-resolver-ad2s1210
create mode 100644 drivers/iio/resolver/ad2s1210.c
delete mode 100644 drivers/staging/iio/Documentation/sysfs-bus-iio-resolver-ad2s1210
delete mode 100644 drivers/staging/iio/resolver/Kconfig
delete mode 100644 drivers/staging/iio/resolver/Makefile
delete mode 100644 drivers/staging/iio/resolver/ad2s1210.c
diff --git a/Documentation/ABI/testing/sysfs-bus-iio-resolver-ad2s1210 b/Documentation/ABI/testing/sysfs-bus-iio-resolver-ad2s1210
new file mode 100644
index 000000000000..f92c79342b93
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-iio-resolver-ad2s1210
@@ -0,0 +1,27 @@
+What: /sys/bus/iio/devices/iio:deviceX/events/in_altvoltage0_mag_rising_reset_max
+KernelVersion: 6.7
+Contact: [email protected]
+Description:
+ Reading returns the current Degradation of Signal Reset Maximum
+ Threshold value in millivolts. Writing sets the value.
+
+What: /sys/bus/iio/devices/iio:deviceX/events/in_altvoltage0_mag_rising_reset_max_available
+KernelVersion: 6.7
+Contact: [email protected]
+Description:
+ Reading returns the allowable voltage range for
+ in_altvoltage0_mag_rising_reset_max.
+
+What: /sys/bus/iio/devices/iio:deviceX/events/in_altvoltage0_mag_rising_reset_min
+KernelVersion: 6.7
+Contact: [email protected]
+Description:
+ Reading returns the current Degradation of Signal Reset Minimum
+ Threshold value in millivolts. Writing sets the value.
+
+What: /sys/bus/iio/devices/iio:deviceX/events/in_altvoltage0_mag_rising_reset_min_available
+KernelVersion: 6.7
+Contact: [email protected]
+Description:
+ Reading returns the allowable voltage range for
+ in_altvoltage0_mag_rising_reset_min.
diff --git a/drivers/iio/resolver/Kconfig b/drivers/iio/resolver/Kconfig
index 47dbfead9b31..424529d36080 100644
--- a/drivers/iio/resolver/Kconfig
+++ b/drivers/iio/resolver/Kconfig
@@ -25,4 +25,17 @@ config AD2S1200
To compile this driver as a module, choose M here: the
module will be called ad2s1200.
+
+config AD2S1210
+ tristate "Analog Devices ad2s1210 driver"
+ depends on SPI
+ depends on COMMON_CLK
+ depends on GPIOLIB || COMPILE_TEST
+ help
+ Say yes here to build support for Analog Devices spi resolver
+ to digital converters, ad2s1210, provides direct access via sysfs.
+
+ To compile this driver as a module, choose M here: the
+ module will be called ad2s1210.
+
endmenu
diff --git a/drivers/iio/resolver/Makefile b/drivers/iio/resolver/Makefile
index fa558138ce45..7f6c876c35ae 100644
--- a/drivers/iio/resolver/Makefile
+++ b/drivers/iio/resolver/Makefile
@@ -5,3 +5,4 @@
obj-$(CONFIG_AD2S90) += ad2s90.o
obj-$(CONFIG_AD2S1200) += ad2s1200.o
+obj-$(CONFIG_AD2S1210) += ad2s1210.o
diff --git a/drivers/iio/resolver/ad2s1210.c b/drivers/iio/resolver/ad2s1210.c
new file mode 100644
index 000000000000..bd4a90c222b5
--- /dev/null
+++ b/drivers/iio/resolver/ad2s1210.c
@@ -0,0 +1,1522 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * ad2s1210.c support for the ADI Resolver to Digital Converters: AD2S1210
+ *
+ * Copyright (c) 2010-2010 Analog Devices Inc.
+ * Copyright (c) 2023 BayLibre, SAS
+ *
+ * Device register to IIO ABI mapping:
+ *
+ * Register | Addr | IIO ABI (sysfs)
+ * ----------------------------|------|-------------------------------------------
+ * DOS Overrange Threshold | 0x89 | events/in_altvoltage0_thresh_rising_value
+ * DOS Mismatch Threshold | 0x8A | events/in_altvoltage0_mag_rising_value
+ * DOS Reset Maximum Threshold | 0x8B | events/in_altvoltage0_mag_rising_reset_max
+ * DOS Reset Minimum Threshold | 0x8C | events/in_altvoltage0_mag_rising_reset_min
+ * LOT High Threshold | 0x8D | events/in_angl1_thresh_rising_value
+ * LOT Low Threshold [1] | 0x8E | events/in_angl1_thresh_rising_hysteresis
+ * Excitation Frequency | 0x91 | out_altvoltage0_frequency
+ * Control | 0x92 | *as bit fields*
+ * Phase lock range | D5 | events/in_phase0_mag_rising_value
+ * Hysteresis | D4 | in_angl0_hysteresis
+ * Encoder resolution | D3:2 | *not implemented*
+ * Resolution | D1:0 | *device tree: assigned-resolution-bits*
+ * Soft Reset | 0xF0 | [2]
+ * Fault | 0xFF | *not implemented*
+ *
+ * [1]: The value written to the LOT low register is high value minus the
+ * hysteresis.
+ * [2]: Soft reset is performed when `out_altvoltage0_frequency` is written.
+ *
+ * Fault to event mapping:
+ *
+ * Fault | | Channel | Type | Direction
+ * ----------------------------------------|----|---------------------------------
+ * Sine/cosine inputs clipped [3] | D7 | altvoltage1 | mag | either
+ * Sine/cosine inputs below LOS | D6 | altvoltage0 | thresh | falling
+ * Sine/cosine inputs exceed DOS overrange | D5 | altvoltage0 | thresh | rising
+ * Sine/cosine inputs exceed DOS mismatch | D4 | altvoltage0 | mag | rising
+ * Tracking error exceeds LOT | D3 | angl1 | thresh | rising
+ * Velocity exceeds maximum tracking rate | D2 | anglvel0 | mag | rising
+ * Phase error exceeds phase lock range | D1 | phase0 | mag | rising
+ * Configuration parity error | D0 | *writes to kernel log*
+ *
+ * [3]: The chip does not differentiate between fault on sine vs. cosine so
+ * there will also be an event on the altvoltage2 channel.
+ */
+
+#include <linux/bitfield.h>
+#include <linux/bits.h>
+#include <linux/cleanup.h>
+#include <linux/clk.h>
+#include <linux/delay.h>
+#include <linux/device.h>
+#include <linux/gpio/consumer.h>
+#include <linux/module.h>
+#include <linux/mutex.h>
+#include <linux/of.h>
+#include <linux/regmap.h>
+#include <linux/slab.h>
+#include <linux/spi/spi.h>
+#include <linux/sysfs.h>
+#include <linux/types.h>
+
+#include <linux/iio/buffer.h>
+#include <linux/iio/events.h>
+#include <linux/iio/iio.h>
+#include <linux/iio/sysfs.h>
+#include <linux/iio/trigger_consumer.h>
+#include <linux/iio/triggered_buffer.h>
+
+#define DRV_NAME "ad2s1210"
+
+/* control register flags */
+#define AD2S1210_ADDRESS_DATA BIT(7)
+#define AD2S1210_PHASE_LOCK_RANGE_44 BIT(5)
+#define AD2S1210_ENABLE_HYSTERESIS BIT(4)
+#define AD2S1210_SET_ENRES GENMASK(3, 2)
+#define AD2S1210_SET_RES GENMASK(1, 0)
+
+/* fault register flags */
+#define AD2S1210_FAULT_CLIP BIT(7)
+#define AD2S1210_FAULT_LOS BIT(6)
+#define AD2S1210_FAULT_DOS_OVR BIT(5)
+#define AD2S1210_FAULT_DOS_MIS BIT(4)
+#define AD2S1210_FAULT_LOT BIT(3)
+#define AD2S1210_FAULT_VELOCITY BIT(2)
+#define AD2S1210_FAULT_PHASE BIT(1)
+#define AD2S1210_FAULT_CONFIG_PARITY BIT(0)
+
+#define AD2S1210_REG_POSITION_MSB 0x80
+#define AD2S1210_REG_POSITION_LSB 0x81
+#define AD2S1210_REG_VELOCITY_MSB 0x82
+#define AD2S1210_REG_VELOCITY_LSB 0x83
+#define AD2S1210_REG_LOS_THRD 0x88
+#define AD2S1210_REG_DOS_OVR_THRD 0x89
+#define AD2S1210_REG_DOS_MIS_THRD 0x8A
+#define AD2S1210_REG_DOS_RST_MAX_THRD 0x8B
+#define AD2S1210_REG_DOS_RST_MIN_THRD 0x8C
+#define AD2S1210_REG_LOT_HIGH_THRD 0x8D
+#define AD2S1210_REG_LOT_LOW_THRD 0x8E
+#define AD2S1210_REG_EXCIT_FREQ 0x91
+#define AD2S1210_REG_CONTROL 0x92
+#define AD2S1210_REG_SOFT_RESET 0xF0
+#define AD2S1210_REG_FAULT 0xFF
+
+#define AD2S1210_MIN_CLKIN 6144000
+#define AD2S1210_MAX_CLKIN 10240000
+#define AD2S1210_MIN_EXCIT 2000
+#define AD2S1210_DEF_EXCIT 10000
+#define AD2S1210_MAX_EXCIT 20000
+#define AD2S1210_MIN_FCW 0x4
+#define AD2S1210_MAX_FCW 0x50
+
+/* 44 degrees ~= 0.767945 radians */
+#define PHASE_44_DEG_TO_RAD_INT 0
+#define PHASE_44_DEG_TO_RAD_MICRO 767945
+/* 360 degrees ~= 6.283185 radians */
+#define PHASE_360_DEG_TO_RAD_INT 6
+#define PHASE_360_DEG_TO_RAD_MICRO 283185
+
+/* Threshold voltage registers have 1 LSB == 38 mV */
+#define THRESHOLD_MILLIVOLT_PER_LSB 38
+/* max voltage for threshold registers is 0x7F * 38 mV */
+#define THRESHOLD_RANGE_STR "[0 38 4826]"
+
+#define FAULT_ONESHOT(bit, new, old) (new & bit && !(old & bit))
+
+enum ad2s1210_mode {
+ MOD_POS = 0b00,
+ MOD_VEL = 0b01,
+ MOD_RESERVED = 0b10,
+ MOD_CONFIG = 0b11,
+};
+
+enum ad2s1210_resolution {
+ AD2S1210_RES_10 = 0b00,
+ AD2S1210_RES_12 = 0b01,
+ AD2S1210_RES_14 = 0b10,
+ AD2S1210_RES_16 = 0b11,
+};
+
+struct ad2s1210_state {
+ struct mutex lock;
+ struct spi_device *sdev;
+ /** GPIO pin connected to SAMPLE line. */
+ struct gpio_desc *sample_gpio;
+ /** GPIO pins connected to A0 and A1 lines. */
+ struct gpio_descs *mode_gpios;
+ /** Used to access config registers. */
+ struct regmap *regmap;
+ /** The external oscillator frequency in Hz. */
+ unsigned long clkin_hz;
+ /** Available raw hysteresis values based on resolution. */
+ int hysteresis_available[2];
+ /** The selected resolution */
+ enum ad2s1210_resolution resolution;
+ /** Copy of fault register from the previous read. */
+ u8 prev_fault_flags;
+ /** For reading raw sample value via SPI. */
+ struct {
+ __be16 raw;
+ u8 fault;
+ } sample __aligned(IIO_DMA_MINALIGN);
+ /** Scan buffer */
+ struct {
+ __be16 chan[2];
+ /* Ensure timestamp is naturally aligned. */
+ s64 timestamp __aligned(8);
+ } scan;
+ /** SPI transmit buffer. */
+ u8 rx[2];
+ /** SPI receive buffer. */
+ u8 tx[2];
+};
+
+static int ad2s1210_set_mode(struct ad2s1210_state *st, enum ad2s1210_mode mode)
+{
+ struct gpio_descs *gpios = st->mode_gpios;
+ DECLARE_BITMAP(bitmap, 2);
+
+ bitmap[0] = mode;
+
+ return gpiod_set_array_value(gpios->ndescs, gpios->desc, gpios->info,
+ bitmap);
+}
+
+/*
+ * Writes the given data to the given register address.
+ *
+ * If the mode is configurable, the device will first be placed in
+ * configuration mode.
+ */
+static int ad2s1210_regmap_reg_write(void *context, unsigned int reg,
+ unsigned int val)
+{
+ struct ad2s1210_state *st = context;
+ struct spi_transfer xfers[] = {
+ {
+ .len = 1,
+ .rx_buf = &st->rx[0],
+ .tx_buf = &st->tx[0],
+ .cs_change = 1,
+ }, {
+ .len = 1,
+ .rx_buf = &st->rx[1],
+ .tx_buf = &st->tx[1],
+ },
+ };
+ int ret;
+
+ /* values can only be 7 bits, the MSB indicates an address */
+ if (val & ~0x7F)
+ return -EINVAL;
+
+ st->tx[0] = reg;
+ st->tx[1] = val;
+
+ ret = ad2s1210_set_mode(st, MOD_CONFIG);
+ if (ret < 0)
+ return ret;
+
+ ret = spi_sync_transfer(st->sdev, xfers, ARRAY_SIZE(xfers));
+ if (ret < 0)
+ return ret;
+
+ /* soft reset also clears the fault register */
+ if (reg == AD2S1210_REG_SOFT_RESET)
+ st->prev_fault_flags = 0;
+
+ return 0;
+}
+
+/*
+ * Reads value from one of the registers.
+ *
+ * If the mode is configurable, the device will first be placed in
+ * configuration mode.
+ */
+static int ad2s1210_regmap_reg_read(void *context, unsigned int reg,
+ unsigned int *val)
+{
+ struct ad2s1210_state *st = context;
+ struct spi_transfer xfers[] = {
+ {
+ .len = 1,
+ .rx_buf = &st->rx[0],
+ .tx_buf = &st->tx[0],
+ .cs_change = 1,
+ }, {
+ .len = 1,
+ .rx_buf = &st->rx[1],
+ .tx_buf = &st->tx[1],
+ },
+ };
+ int ret;
+
+ ret = ad2s1210_set_mode(st, MOD_CONFIG);
+ if (ret < 0)
+ return ret;
+
+ st->tx[0] = reg;
+ /*
+ * Must be valid register address here otherwise this could write data.
+ * It doesn't matter which one as long as reading doesn't have side-
+ * effects.
+ */
+ st->tx[1] = AD2S1210_REG_CONTROL;
+
+ ret = spi_sync_transfer(st->sdev, xfers, ARRAY_SIZE(xfers));
+ if (ret < 0)
+ return ret;
+
+ /* reading the fault register also clears it */
+ if (reg == AD2S1210_REG_FAULT)
+ st->prev_fault_flags = 0;
+
+ /*
+ * If the D7 bit is set on any read/write register, it indicates a
+ * parity error. The fault register is read-only and the D7 bit means
+ * something else there.
+ */
+ if (reg != AD2S1210_REG_FAULT && st->rx[1] & AD2S1210_ADDRESS_DATA)
+ return -EBADMSG;
+
+ *val = st->rx[1];
+
+ return 0;
+}
+
+/*
+ * Toggles the SAMPLE line on the AD2S1210 to latch in the current position,
+ * velocity, and faults.
+ *
+ * Must be called with lock held.
+ */
+static void ad2s1210_toggle_sample_line(struct ad2s1210_state *st)
+{
+ /*
+ * Datasheet specifies minimum hold time t16 = 2 * tck + 20 ns. So the
+ * longest time needed is when CLKIN is 6.144 MHz, in which case t16
+ * ~= 350 ns. The same delay is also needed before re-asserting the
+ * SAMPLE line.
+ */
+ gpiod_set_value(st->sample_gpio, 1);
+ ndelay(350);
+ gpiod_set_value(st->sample_gpio, 0);
+ ndelay(350);
+}
+
+/*
+ * Sets the excitation frequency and performs software reset.
+ *
+ * Must be called with lock held.
+ */
+static int ad2s1210_reinit_excitation_frequency(struct ad2s1210_state *st,
+ u16 fexcit)
+{
+ /* Map resolution to settle time in milliseconds. */
+ static const int track_time_ms[] = { 10, 20, 25, 60 };
+ unsigned int ignored;
+ int ret;
+ u8 fcw;
+
+ fcw = fexcit * (1 << 15) / st->clkin_hz;
+ if (fcw < AD2S1210_MIN_FCW || fcw > AD2S1210_MAX_FCW)
+ return -ERANGE;
+
+ ret = regmap_write(st->regmap, AD2S1210_REG_EXCIT_FREQ, fcw);
+ if (ret < 0)
+ return ret;
+
+ /*
+ * Software reset reinitializes the excitation frequency output.
+ * It does not reset any of the configuration registers.
+ */
+ ret = regmap_write(st->regmap, AD2S1210_REG_SOFT_RESET, 0);
+ if (ret < 0)
+ return ret;
+
+ /*
+ * Soft reset always triggers some faults due the change in the output
+ * signal so clear the faults too. We need to delay for some time
+ * (what datasheet calls t[track]) to allow things to settle before
+ * clearing the faults.
+ */
+ msleep(track_time_ms[st->resolution] * 8192000 / st->clkin_hz);
+
+ /* Reading the fault register clears the faults. */
+ ret = regmap_read(st->regmap, AD2S1210_REG_FAULT, &ignored);
+ if (ret < 0)
+ return ret;
+
+ /* Have to toggle sample line to get fault output pins to reset. */
+ ad2s1210_toggle_sample_line(st);
+
+ return 0;
+}
+
+static void ad2s1210_push_events(struct iio_dev *indio_dev,
+ u8 flags, s64 timestamp)
+{
+ struct ad2s1210_state *st = iio_priv(indio_dev);
+
+ /* Sine/cosine inputs clipped */
+ if (FAULT_ONESHOT(AD2S1210_FAULT_CLIP, flags, st->prev_fault_flags)) {
+ /*
+ * The chip does not differentiate between fault on sine vs.
+ * cosine channel so we just send an event on both channels.
+ */
+ iio_push_event(indio_dev,
+ IIO_UNMOD_EVENT_CODE(IIO_ALTVOLTAGE, 1,
+ IIO_EV_TYPE_MAG,
+ IIO_EV_DIR_EITHER),
+ timestamp);
+ iio_push_event(indio_dev,
+ IIO_UNMOD_EVENT_CODE(IIO_ALTVOLTAGE, 2,
+ IIO_EV_TYPE_MAG,
+ IIO_EV_DIR_EITHER),
+ timestamp);
+ }
+
+ /* Sine/cosine inputs below LOS threshold */
+ if (FAULT_ONESHOT(AD2S1210_FAULT_LOS, flags, st->prev_fault_flags))
+ iio_push_event(indio_dev,
+ IIO_UNMOD_EVENT_CODE(IIO_ALTVOLTAGE, 0,
+ IIO_EV_TYPE_THRESH,
+ IIO_EV_DIR_FALLING),
+ timestamp);
+
+ /* Sine/cosine inputs exceed DOS overrange threshold */
+ if (FAULT_ONESHOT(AD2S1210_FAULT_DOS_OVR, flags, st->prev_fault_flags))
+ iio_push_event(indio_dev,
+ IIO_UNMOD_EVENT_CODE(IIO_ALTVOLTAGE, 0,
+ IIO_EV_TYPE_THRESH,
+ IIO_EV_DIR_RISING),
+ timestamp);
+
+ /* Sine/cosine inputs exceed DOS mismatch threshold */
+ if (FAULT_ONESHOT(AD2S1210_FAULT_DOS_MIS, flags, st->prev_fault_flags))
+ iio_push_event(indio_dev,
+ IIO_UNMOD_EVENT_CODE(IIO_ALTVOLTAGE, 0,
+ IIO_EV_TYPE_MAG,
+ IIO_EV_DIR_RISING),
+ timestamp);
+
+ /* Tracking error exceeds LOT threshold */
+ if (FAULT_ONESHOT(AD2S1210_FAULT_LOT, flags, st->prev_fault_flags))
+ iio_push_event(indio_dev,
+ IIO_UNMOD_EVENT_CODE(IIO_ANGL, 1,
+ IIO_EV_TYPE_THRESH,
+ IIO_EV_DIR_RISING),
+ timestamp);
+
+ /* Velocity exceeds maximum tracking rate */
+ if (FAULT_ONESHOT(AD2S1210_FAULT_VELOCITY, flags, st->prev_fault_flags))
+ iio_push_event(indio_dev,
+ IIO_UNMOD_EVENT_CODE(IIO_ANGL_VEL, 0,
+ IIO_EV_TYPE_THRESH,
+ IIO_EV_DIR_RISING),
+ timestamp);
+
+ /* Phase error exceeds phase lock range */
+ if (FAULT_ONESHOT(AD2S1210_FAULT_PHASE, flags, st->prev_fault_flags))
+ iio_push_event(indio_dev,
+ IIO_UNMOD_EVENT_CODE(IIO_PHASE, 0,
+ IIO_EV_TYPE_MAG,
+ IIO_EV_DIR_RISING),
+ timestamp);
+
+ /* Configuration parity error */
+ if (FAULT_ONESHOT(AD2S1210_FAULT_CONFIG_PARITY, flags,
+ st->prev_fault_flags))
+ /*
+ * Userspace should also get notified of this via error return
+ * when trying to write to any attribute that writes a register.
+ */
+ dev_err_ratelimited(&indio_dev->dev,
+ "Configuration parity error\n");
+
+ st->prev_fault_flags = flags;
+}
+
+static int ad2s1210_single_conversion(struct iio_dev *indio_dev,
+ struct iio_chan_spec const *chan,
+ int *val)
+{
+ struct ad2s1210_state *st = iio_priv(indio_dev);
+ s64 timestamp;
+ int ret;
+
+ guard(mutex)(&st->lock);
+
+ ad2s1210_toggle_sample_line(st);
+ timestamp = iio_get_time_ns(indio_dev);
+
+ switch (chan->type) {
+ case IIO_ANGL:
+ ret = ad2s1210_set_mode(st, MOD_POS);
+ break;
+ case IIO_ANGL_VEL:
+ ret = ad2s1210_set_mode(st, MOD_VEL);
+ break;
+ default:
+ return -EINVAL;
+ }
+ if (ret < 0)
+ return ret;
+ ret = spi_read(st->sdev, &st->sample, 3);
+ if (ret < 0)
+ return ret;
+
+ switch (chan->type) {
+ case IIO_ANGL:
+ *val = be16_to_cpu(st->sample.raw);
+ ret = IIO_VAL_INT;
+ break;
+ case IIO_ANGL_VEL:
+ *val = (s16)be16_to_cpu(st->sample.raw);
+ ret = IIO_VAL_INT;
+ break;
+ default:
+ return -EINVAL;
+ }
+
+ ad2s1210_push_events(indio_dev, st->sample.fault, timestamp);
+
+ return ret;
+}
+
+static int ad2s1210_get_hysteresis(struct ad2s1210_state *st, int *val)
+{
+ int ret;
+
+ guard(mutex)(&st->lock);
+ ret = regmap_test_bits(st->regmap, AD2S1210_REG_CONTROL,
+ AD2S1210_ENABLE_HYSTERESIS);
+ if (ret < 0)
+ return ret;
+
+ *val = ret << (2 * (AD2S1210_RES_16 - st->resolution));
+ return IIO_VAL_INT;
+}
+
+static int ad2s1210_set_hysteresis(struct ad2s1210_state *st, int val)
+{
+ guard(mutex)(&st->lock);
+ return regmap_update_bits(st->regmap, AD2S1210_REG_CONTROL,
+ AD2S1210_ENABLE_HYSTERESIS,
+ val ? AD2S1210_ENABLE_HYSTERESIS : 0);
+}
+
+static int ad2s1210_get_phase_lock_range(struct ad2s1210_state *st,
+ int *val, int *val2)
+{
+ int ret;
+
+ guard(mutex)(&st->lock);
+ ret = regmap_test_bits(st->regmap, AD2S1210_REG_CONTROL,
+ AD2S1210_PHASE_LOCK_RANGE_44);
+ if (ret < 0)
+ return ret;
+
+ if (ret) {
+ /* 44 degrees as radians */
+ *val = PHASE_44_DEG_TO_RAD_INT;
+ *val2 = PHASE_44_DEG_TO_RAD_MICRO;
+ } else {
+ /* 360 degrees as radians */
+ *val = PHASE_360_DEG_TO_RAD_INT;
+ *val2 = PHASE_360_DEG_TO_RAD_MICRO;
+ }
+
+ return IIO_VAL_INT_PLUS_MICRO;
+}
+
+static int ad2s1210_set_phase_lock_range(struct ad2s1210_state *st,
+ int val, int val2)
+{
+ int deg;
+
+ /* convert radians to degrees - only two allowable values */
+ if (val == PHASE_44_DEG_TO_RAD_INT && val2 == PHASE_44_DEG_TO_RAD_MICRO)
+ deg = 44;
+ else if (val == PHASE_360_DEG_TO_RAD_INT &&
+ val2 == PHASE_360_DEG_TO_RAD_MICRO)
+ deg = 360;
+ else
+ return -EINVAL;
+
+ guard(mutex)(&st->lock);
+ return regmap_update_bits(st->regmap, AD2S1210_REG_CONTROL,
+ AD2S1210_PHASE_LOCK_RANGE_44,
+ deg == 44 ? AD2S1210_PHASE_LOCK_RANGE_44 : 0);
+}
+
+/* map resolution to microradians/LSB for LOT registers */
+static const int ad2s1210_lot_threshold_urad_per_lsb[] = {
+ 6184, /* 10-bit: ~0.35 deg/LSB, 45 deg max */
+ 2473, /* 12-bit: ~0.14 deg/LSB, 18 deg max */
+ 1237, /* 14-bit: ~0.07 deg/LSB, 9 deg max */
+ 1237, /* 16-bit: same as 14-bit */
+};
+
+static int ad2s1210_get_voltage_threshold(struct ad2s1210_state *st,
+ unsigned int reg, int *val)
+{
+ unsigned int reg_val;
+ int ret;
+
+ guard(mutex)(&st->lock);
+ ret = regmap_read(st->regmap, reg, ®_val);
+ if (ret < 0)
+ return ret;
+
+ *val = reg_val * THRESHOLD_MILLIVOLT_PER_LSB;
+ return IIO_VAL_INT;
+}
+
+static int ad2s1210_set_voltage_threshold(struct ad2s1210_state *st,
+ unsigned int reg, int val)
+{
+ unsigned int reg_val;
+
+ reg_val = val / THRESHOLD_MILLIVOLT_PER_LSB;
+
+ guard(mutex)(&st->lock);
+ return regmap_write(st->regmap, reg, reg_val);
+}
+
+static int ad2s1210_get_lot_high_threshold(struct ad2s1210_state *st,
+ int *val, int *val2)
+{
+ unsigned int reg_val;
+ int ret;
+
+ guard(mutex)(&st->lock);
+ ret = regmap_read(st->regmap, AD2S1210_REG_LOT_HIGH_THRD, ®_val);
+ if (ret < 0)
+ return ret;
+
+ *val = 0;
+ *val2 = reg_val * ad2s1210_lot_threshold_urad_per_lsb[st->resolution];
+ return IIO_VAL_INT_PLUS_MICRO;
+}
+
+static int ad2s1210_set_lot_high_threshold(struct ad2s1210_state *st,
+ int val, int val2)
+{
+ unsigned int high_reg_val, low_reg_val, hysteresis;
+ int ret;
+
+ /* all valid values are between 0 and pi/4 radians */
+ if (val != 0)
+ return -EINVAL;
+
+ guard(mutex)(&st->lock);
+ /*
+ * We need to read both high and low registers first so we can preserve
+ * the hysteresis.
+ */
+ ret = regmap_read(st->regmap, AD2S1210_REG_LOT_HIGH_THRD, &high_reg_val);
+ if (ret < 0)
+ return ret;
+
+ ret = regmap_read(st->regmap, AD2S1210_REG_LOT_LOW_THRD, &low_reg_val);
+ if (ret < 0)
+ return ret;
+
+ hysteresis = high_reg_val - low_reg_val;
+ high_reg_val = val2 / ad2s1210_lot_threshold_urad_per_lsb[st->resolution];
+ low_reg_val = high_reg_val - hysteresis;
+
+ ret = regmap_write(st->regmap, AD2S1210_REG_LOT_HIGH_THRD, high_reg_val);
+ if (ret < 0)
+ return ret;
+
+ return regmap_write(st->regmap, AD2S1210_REG_LOT_LOW_THRD, low_reg_val);
+}
+
+static int ad2s1210_get_lot_low_threshold(struct ad2s1210_state *st,
+ int *val, int *val2)
+{
+ unsigned int high_reg_val, low_reg_val;
+ int ret;
+
+ guard(mutex)(&st->lock);
+
+ ret = regmap_read(st->regmap, AD2S1210_REG_LOT_HIGH_THRD, &high_reg_val);
+ if (ret < 0)
+ return ret;
+
+ ret = regmap_read(st->regmap, AD2S1210_REG_LOT_LOW_THRD, &low_reg_val);
+ if (ret < 0)
+ return ret;
+
+ /* sysfs value is hysteresis rather than actual low value */
+ *val = 0;
+ *val2 = (high_reg_val - low_reg_val) *
+ ad2s1210_lot_threshold_urad_per_lsb[st->resolution];
+ return IIO_VAL_INT_PLUS_MICRO;
+}
+
+static int ad2s1210_set_lot_low_threshold(struct ad2s1210_state *st,
+ int val, int val2)
+{
+ unsigned int reg_val, hysteresis;
+ int ret;
+
+ /* all valid values are between 0 and pi/4 radians */
+ if (val != 0)
+ return -EINVAL;
+
+ hysteresis = val2 / ad2s1210_lot_threshold_urad_per_lsb[st->resolution];
+
+ guard(mutex)(&st->lock);
+
+ ret = regmap_read(st->regmap, AD2S1210_REG_LOT_HIGH_THRD, ®_val);
+ if (ret < 0)
+ return ret;
+
+ return regmap_write(st->regmap, AD2S1210_REG_LOT_LOW_THRD,
+ reg_val - hysteresis);
+}
+
+static int ad2s1210_get_excitation_frequency(struct ad2s1210_state *st, int *val)
+{
+ unsigned int reg_val;
+ int ret;
+
+ guard(mutex)(&st->lock);
+
+ ret = regmap_read(st->regmap, AD2S1210_REG_EXCIT_FREQ, ®_val);
+ if (ret < 0)
+ return ret;
+
+ *val = reg_val * st->clkin_hz / (1 << 15);
+ return IIO_VAL_INT;
+}
+
+static int ad2s1210_set_excitation_frequency(struct ad2s1210_state *st, int val)
+{
+ if (val < AD2S1210_MIN_EXCIT || val > AD2S1210_MAX_EXCIT)
+ return -EINVAL;
+
+ guard(mutex)(&st->lock);
+ return ad2s1210_reinit_excitation_frequency(st, val);
+}
+
+static const int ad2s1210_velocity_scale[] = {
+ 17089132, /* 8.192MHz / (2*pi * 2500 / 2^15) */
+ 42722830, /* 8.192MHz / (2*pi * 1000 / 2^15) */
+ 85445659, /* 8.192MHz / (2*pi * 500 / 2^15) */
+ 341782638, /* 8.192MHz / (2*pi * 125 / 2^15) */
+};
+
+static int ad2s1210_read_raw(struct iio_dev *indio_dev,
+ struct iio_chan_spec const *chan,
+ int *val,
+ int *val2,
+ long mask)
+{
+ struct ad2s1210_state *st = iio_priv(indio_dev);
+
+ switch (mask) {
+ case IIO_CHAN_INFO_RAW:
+ return ad2s1210_single_conversion(indio_dev, chan, val);
+ case IIO_CHAN_INFO_SCALE:
+ switch (chan->type) {
+ case IIO_ANGL:
+ /* approx 0.3 arc min converted to radians */
+ *val = 0;
+ *val2 = 95874;
+ return IIO_VAL_INT_PLUS_NANO;
+ case IIO_ANGL_VEL:
+ *val = st->clkin_hz;
+ *val2 = ad2s1210_velocity_scale[st->resolution];
+ return IIO_VAL_FRACTIONAL;
+ default:
+ return -EINVAL;
+ }
+ case IIO_CHAN_INFO_FREQUENCY:
+ switch (chan->type) {
+ case IIO_ALTVOLTAGE:
+ return ad2s1210_get_excitation_frequency(st, val);
+ default:
+ return -EINVAL;
+ }
+ case IIO_CHAN_INFO_HYSTERESIS:
+ switch (chan->type) {
+ case IIO_ANGL:
+ return ad2s1210_get_hysteresis(st, val);
+ default:
+ return -EINVAL;
+ }
+ default:
+ return -EINVAL;
+ }
+}
+
+static int ad2s1210_read_avail(struct iio_dev *indio_dev,
+ struct iio_chan_spec const *chan,
+ const int **vals, int *type,
+ int *length, long mask)
+{
+ static const int excitation_frequency_available[] = {
+ AD2S1210_MIN_EXCIT,
+ 250, /* step */
+ AD2S1210_MAX_EXCIT,
+ };
+
+ struct ad2s1210_state *st = iio_priv(indio_dev);
+
+ switch (mask) {
+ case IIO_CHAN_INFO_FREQUENCY:
+ switch (chan->type) {
+ case IIO_ALTVOLTAGE:
+ *type = IIO_VAL_INT;
+ *vals = excitation_frequency_available;
+ return IIO_AVAIL_RANGE;
+ default:
+ return -EINVAL;
+ }
+ case IIO_CHAN_INFO_HYSTERESIS:
+ switch (chan->type) {
+ case IIO_ANGL:
+ *vals = st->hysteresis_available;
+ *type = IIO_VAL_INT;
+ *length = ARRAY_SIZE(st->hysteresis_available);
+ return IIO_AVAIL_LIST;
+ default:
+ return -EINVAL;
+ }
+ default:
+ return -EINVAL;
+ }
+}
+
+static int ad2s1210_write_raw(struct iio_dev *indio_dev,
+ struct iio_chan_spec const *chan,
+ int val, int val2, long mask)
+{
+ struct ad2s1210_state *st = iio_priv(indio_dev);
+
+ switch (mask) {
+ case IIO_CHAN_INFO_FREQUENCY:
+ switch (chan->type) {
+ case IIO_ALTVOLTAGE:
+ return ad2s1210_set_excitation_frequency(st, val);
+ default:
+ return -EINVAL;
+ }
+ case IIO_CHAN_INFO_HYSTERESIS:
+ switch (chan->type) {
+ case IIO_ANGL:
+ return ad2s1210_set_hysteresis(st, val);
+ default:
+ return -EINVAL;
+ }
+ default:
+ return -EINVAL;
+ }
+}
+
+static const struct iio_event_spec ad2s1210_position_event_spec[] = {
+ {
+ /* Tracking error exceeds LOT threshold fault. */
+ .type = IIO_EV_TYPE_THRESH,
+ .dir = IIO_EV_DIR_RISING,
+ .mask_separate =
+ /* Loss of tracking high threshold. */
+ BIT(IIO_EV_INFO_VALUE) |
+ /* Loss of tracking low threshold. */
+ BIT(IIO_EV_INFO_HYSTERESIS),
+ },
+};
+
+static const struct iio_event_spec ad2s1210_velocity_event_spec[] = {
+ {
+ /* Velocity exceeds maximum tracking rate fault. */
+ .type = IIO_EV_TYPE_MAG,
+ .dir = IIO_EV_DIR_RISING,
+ },
+};
+
+static const struct iio_event_spec ad2s1210_phase_event_spec[] = {
+ {
+ /* Phase error fault. */
+ .type = IIO_EV_TYPE_MAG,
+ .dir = IIO_EV_DIR_RISING,
+ /* Phase lock range. */
+ .mask_separate = BIT(IIO_EV_INFO_VALUE),
+ },
+};
+
+static const struct iio_event_spec ad2s1210_monitor_signal_event_spec[] = {
+ {
+ /* Sine/cosine below LOS threshold fault. */
+ .type = IIO_EV_TYPE_THRESH,
+ .dir = IIO_EV_DIR_FALLING,
+ /* Loss of signal threshold. */
+ .mask_separate = BIT(IIO_EV_INFO_VALUE),
+ },
+ {
+ /* Sine/cosine DOS overrange fault.*/
+ .type = IIO_EV_TYPE_THRESH,
+ .dir = IIO_EV_DIR_RISING,
+ /* Degredation of signal overrange threshold. */
+ .mask_separate = BIT(IIO_EV_INFO_VALUE),
+ },
+ {
+ /* Sine/cosine DOS mismatch fault.*/
+ .type = IIO_EV_TYPE_MAG,
+ .dir = IIO_EV_DIR_RISING,
+ .mask_separate = BIT(IIO_EV_INFO_VALUE),
+ },
+};
+
+static const struct iio_event_spec ad2s1210_sin_cos_event_spec[] = {
+ {
+ /* Sine/cosine clipping fault. */
+ .type = IIO_EV_TYPE_MAG,
+ .dir = IIO_EV_DIR_EITHER,
+ },
+};
+
+static const struct iio_chan_spec ad2s1210_channels[] = {
+ {
+ .type = IIO_ANGL,
+ .indexed = 1,
+ .channel = 0,
+ .scan_index = 0,
+ .scan_type = {
+ .sign = 'u',
+ .realbits = 16,
+ .storagebits = 16,
+ .endianness = IIO_BE,
+ },
+ .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
+ BIT(IIO_CHAN_INFO_SCALE) |
+ BIT(IIO_CHAN_INFO_HYSTERESIS),
+ .info_mask_separate_available =
+ BIT(IIO_CHAN_INFO_HYSTERESIS),
+ }, {
+ .type = IIO_ANGL_VEL,
+ .indexed = 1,
+ .channel = 0,
+ .scan_index = 1,
+ .scan_type = {
+ .sign = 's',
+ .realbits = 16,
+ .storagebits = 16,
+ .endianness = IIO_BE,
+ },
+ .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
+ BIT(IIO_CHAN_INFO_SCALE),
+ .event_spec = ad2s1210_velocity_event_spec,
+ .num_event_specs = ARRAY_SIZE(ad2s1210_velocity_event_spec),
+ },
+ IIO_CHAN_SOFT_TIMESTAMP(2),
+ {
+ /* used to configure LOT thresholds and get tracking error */
+ .type = IIO_ANGL,
+ .indexed = 1,
+ .channel = 1,
+ .scan_index = -1,
+ .event_spec = ad2s1210_position_event_spec,
+ .num_event_specs = ARRAY_SIZE(ad2s1210_position_event_spec),
+ },
+ {
+ /* used to configure phase lock range and get phase lock error */
+ .type = IIO_PHASE,
+ .indexed = 1,
+ .channel = 0,
+ .scan_index = -1,
+ .event_spec = ad2s1210_phase_event_spec,
+ .num_event_specs = ARRAY_SIZE(ad2s1210_phase_event_spec),
+ }, {
+ /* excitation frequency output */
+ .type = IIO_ALTVOLTAGE,
+ .indexed = 1,
+ .channel = 0,
+ .output = 1,
+ .scan_index = -1,
+ .info_mask_separate = BIT(IIO_CHAN_INFO_FREQUENCY),
+ .info_mask_separate_available = BIT(IIO_CHAN_INFO_FREQUENCY),
+ }, {
+ /* monitor signal */
+ .type = IIO_ALTVOLTAGE,
+ .indexed = 1,
+ .channel = 0,
+ .scan_index = -1,
+ .event_spec = ad2s1210_monitor_signal_event_spec,
+ .num_event_specs = ARRAY_SIZE(ad2s1210_monitor_signal_event_spec),
+ }, {
+ /* sine input */
+ .type = IIO_ALTVOLTAGE,
+ .indexed = 1,
+ .channel = 1,
+ .scan_index = -1,
+ .event_spec = ad2s1210_sin_cos_event_spec,
+ .num_event_specs = ARRAY_SIZE(ad2s1210_sin_cos_event_spec),
+ }, {
+ /* cosine input */
+ .type = IIO_ALTVOLTAGE,
+ .indexed = 1,
+ .channel = 2,
+ .scan_index = -1,
+ .event_spec = ad2s1210_sin_cos_event_spec,
+ .num_event_specs = ARRAY_SIZE(ad2s1210_sin_cos_event_spec),
+ },
+};
+
+static ssize_t event_attr_voltage_reg_show(struct device *dev,
+ struct device_attribute *attr,
+ char *buf)
+{
+ struct ad2s1210_state *st = iio_priv(dev_to_iio_dev(dev));
+ struct iio_dev_attr *iattr = to_iio_dev_attr(attr);
+ unsigned int value;
+ int ret;
+
+ guard(mutex)(&st->lock);
+ ret = regmap_read(st->regmap, iattr->address, &value);
+ if (ret < 0)
+ return ret;
+
+ return sprintf(buf, "%d\n", value * THRESHOLD_MILLIVOLT_PER_LSB);
+}
+
+static ssize_t event_attr_voltage_reg_store(struct device *dev,
+ struct device_attribute *attr,
+ const char *buf, size_t len)
+{
+ struct ad2s1210_state *st = iio_priv(dev_to_iio_dev(dev));
+ struct iio_dev_attr *iattr = to_iio_dev_attr(attr);
+ u16 data;
+ int ret;
+
+ ret = kstrtou16(buf, 10, &data);
+ if (ret)
+ return -EINVAL;
+
+ guard(mutex)(&st->lock);
+ ret = regmap_write(st->regmap, iattr->address,
+ data / THRESHOLD_MILLIVOLT_PER_LSB);
+ if (ret < 0)
+ return ret;
+
+ return len;
+}
+
+static ssize_t
+in_angl1_thresh_rising_value_available_show(struct device *dev,
+ struct device_attribute *attr,
+ char *buf)
+{
+ struct ad2s1210_state *st = iio_priv(dev_to_iio_dev(dev));
+ int step = ad2s1210_lot_threshold_urad_per_lsb[st->resolution];
+
+ return sysfs_emit(buf, "[0 0.%06d 0.%06d]\n", step, step * 0x7F);
+}
+
+static ssize_t
+in_angl1_thresh_rising_hysteresis_available_show(struct device *dev,
+ struct device_attribute *attr,
+ char *buf)
+{
+ struct ad2s1210_state *st = iio_priv(dev_to_iio_dev(dev));
+ int step = ad2s1210_lot_threshold_urad_per_lsb[st->resolution];
+
+ return sysfs_emit(buf, "[0 0.%06d 0.%06d]\n", step, step * 0x7F);
+}
+
+static IIO_CONST_ATTR(in_phase0_mag_rising_value_available,
+ __stringify(PHASE_44_DEG_TO_RAD_INT) "."
+ __stringify(PHASE_44_DEG_TO_RAD_MICRO) " "
+ __stringify(PHASE_360_DEG_TO_RAD_INT) "."
+ __stringify(PHASE_360_DEG_TO_RAD_MICRO));
+static IIO_CONST_ATTR(in_altvoltage0_thresh_falling_value_available,
+ THRESHOLD_RANGE_STR);
+static IIO_CONST_ATTR(in_altvoltage0_thresh_rising_value_available,
+ THRESHOLD_RANGE_STR);
+static IIO_CONST_ATTR(in_altvoltage0_mag_rising_value_available,
+ THRESHOLD_RANGE_STR);
+static IIO_DEVICE_ATTR(in_altvoltage0_mag_rising_reset_max, 0644,
+ event_attr_voltage_reg_show, event_attr_voltage_reg_store,
+ AD2S1210_REG_DOS_RST_MAX_THRD);
+static IIO_CONST_ATTR(in_altvoltage0_mag_rising_reset_max_available, THRESHOLD_RANGE_STR);
+static IIO_DEVICE_ATTR(in_altvoltage0_mag_rising_reset_min, 0644,
+ event_attr_voltage_reg_show, event_attr_voltage_reg_store,
+ AD2S1210_REG_DOS_RST_MIN_THRD);
+static IIO_CONST_ATTR(in_altvoltage0_mag_rising_reset_min_available, THRESHOLD_RANGE_STR);
+static IIO_DEVICE_ATTR_RO(in_angl1_thresh_rising_value_available, 0);
+static IIO_DEVICE_ATTR_RO(in_angl1_thresh_rising_hysteresis_available, 0);
+
+static struct attribute *ad2s1210_event_attributes[] = {
+ &iio_const_attr_in_phase0_mag_rising_value_available.dev_attr.attr,
+ &iio_const_attr_in_altvoltage0_thresh_falling_value_available.dev_attr.attr,
+ &iio_const_attr_in_altvoltage0_thresh_rising_value_available.dev_attr.attr,
+ &iio_const_attr_in_altvoltage0_mag_rising_value_available.dev_attr.attr,
+ &iio_dev_attr_in_altvoltage0_mag_rising_reset_max.dev_attr.attr,
+ &iio_const_attr_in_altvoltage0_mag_rising_reset_max_available.dev_attr.attr,
+ &iio_dev_attr_in_altvoltage0_mag_rising_reset_min.dev_attr.attr,
+ &iio_const_attr_in_altvoltage0_mag_rising_reset_min_available.dev_attr.attr,
+ &iio_dev_attr_in_angl1_thresh_rising_value_available.dev_attr.attr,
+ &iio_dev_attr_in_angl1_thresh_rising_hysteresis_available.dev_attr.attr,
+ NULL,
+};
+
+static const struct attribute_group ad2s1210_event_attribute_group = {
+ .attrs = ad2s1210_event_attributes,
+};
+
+static int ad2s1210_initial(struct ad2s1210_state *st)
+{
+ unsigned int data;
+ int ret;
+
+ guard(mutex)(&st->lock);
+
+ /* Use default config register value plus resolution from devicetree. */
+ data = FIELD_PREP(AD2S1210_PHASE_LOCK_RANGE_44, 1);
+ data |= FIELD_PREP(AD2S1210_ENABLE_HYSTERESIS, 1);
+ data |= FIELD_PREP(AD2S1210_SET_ENRES, 0x3);
+ data |= FIELD_PREP(AD2S1210_SET_RES, st->resolution);
+
+ ret = regmap_write(st->regmap, AD2S1210_REG_CONTROL, data);
+ if (ret < 0)
+ return ret;
+
+ return ad2s1210_reinit_excitation_frequency(st, AD2S1210_DEF_EXCIT);
+}
+
+static int ad2s1210_read_label(struct iio_dev *indio_dev,
+ struct iio_chan_spec const *chan,
+ char *label)
+{
+ if (chan->type == IIO_ANGL) {
+ if (chan->channel == 0)
+ return sprintf(label, "position\n");
+ if (chan->channel == 1)
+ return sprintf(label, "tracking error\n");
+ }
+ if (chan->type == IIO_ANGL_VEL)
+ return sprintf(label, "velocity\n");
+ if (chan->type == IIO_PHASE)
+ return sprintf(label, "synthetic reference\n");
+ if (chan->type == IIO_ALTVOLTAGE) {
+ if (chan->output)
+ return sprintf(label, "excitation\n");
+ if (chan->channel == 0)
+ return sprintf(label, "monitor signal\n");
+ if (chan->channel == 1)
+ return sprintf(label, "cosine\n");
+ if (chan->channel == 2)
+ return sprintf(label, "sine\n");
+ }
+
+ return -EINVAL;
+}
+
+static int ad2s1210_read_event_value(struct iio_dev *indio_dev,
+ const struct iio_chan_spec *chan,
+ enum iio_event_type type,
+ enum iio_event_direction dir,
+ enum iio_event_info info,
+ int *val, int *val2)
+{
+ struct ad2s1210_state *st = iio_priv(indio_dev);
+
+ switch (chan->type) {
+ case IIO_ANGL:
+ switch (info) {
+ case IIO_EV_INFO_VALUE:
+ return ad2s1210_get_lot_high_threshold(st, val, val2);
+ case IIO_EV_INFO_HYSTERESIS:
+ return ad2s1210_get_lot_low_threshold(st, val, val2);
+ default:
+ return -EINVAL;
+ }
+ case IIO_ALTVOLTAGE:
+ if (chan->output)
+ return -EINVAL;
+ if (type == IIO_EV_TYPE_THRESH && dir == IIO_EV_DIR_FALLING)
+ return ad2s1210_get_voltage_threshold(st,
+ AD2S1210_REG_LOS_THRD, val);
+ if (type == IIO_EV_TYPE_THRESH && dir == IIO_EV_DIR_RISING)
+ return ad2s1210_get_voltage_threshold(st,
+ AD2S1210_REG_DOS_OVR_THRD, val);
+ if (type == IIO_EV_TYPE_MAG)
+ return ad2s1210_get_voltage_threshold(st,
+ AD2S1210_REG_DOS_MIS_THRD, val);
+ return -EINVAL;
+ case IIO_PHASE:
+ return ad2s1210_get_phase_lock_range(st, val, val2);
+ default:
+ return -EINVAL;
+ }
+}
+
+static int ad2s1210_write_event_value(struct iio_dev *indio_dev,
+ const struct iio_chan_spec *chan,
+ enum iio_event_type type,
+ enum iio_event_direction dir,
+ enum iio_event_info info,
+ int val, int val2)
+{
+ struct ad2s1210_state *st = iio_priv(indio_dev);
+
+ switch (chan->type) {
+ case IIO_ANGL:
+ switch (info) {
+ case IIO_EV_INFO_VALUE:
+ return ad2s1210_set_lot_high_threshold(st, val, val2);
+ case IIO_EV_INFO_HYSTERESIS:
+ return ad2s1210_set_lot_low_threshold(st, val, val2);
+ default:
+ return -EINVAL;
+ }
+ case IIO_ALTVOLTAGE:
+ if (chan->output)
+ return -EINVAL;
+ if (type == IIO_EV_TYPE_THRESH && dir == IIO_EV_DIR_FALLING)
+ return ad2s1210_set_voltage_threshold(st,
+ AD2S1210_REG_LOS_THRD, val);
+ if (type == IIO_EV_TYPE_THRESH && dir == IIO_EV_DIR_RISING)
+ return ad2s1210_set_voltage_threshold(st,
+ AD2S1210_REG_DOS_OVR_THRD, val);
+ if (type == IIO_EV_TYPE_MAG)
+ return ad2s1210_set_voltage_threshold(st,
+ AD2S1210_REG_DOS_MIS_THRD, val);
+ return -EINVAL;
+ case IIO_PHASE:
+ return ad2s1210_set_phase_lock_range(st, val, val2);
+ default:
+ return -EINVAL;
+ }
+}
+
+static int ad2s1210_read_event_label(struct iio_dev *indio_dev,
+ struct iio_chan_spec const *chan,
+ enum iio_event_type type,
+ enum iio_event_direction dir,
+ char *label)
+{
+ if (chan->type == IIO_ANGL)
+ return sprintf(label, "LOT\n");
+ if (chan->type == IIO_ANGL_VEL)
+ return sprintf(label, "max tracking rate\n");
+ if (chan->type == IIO_PHASE)
+ return sprintf(label, "phase lock\n");
+ if (chan->type == IIO_ALTVOLTAGE) {
+ if (chan->channel == 0) {
+ if (type == IIO_EV_TYPE_THRESH &&
+ dir == IIO_EV_DIR_FALLING)
+ return sprintf(label, "LOS\n");
+ if (type == IIO_EV_TYPE_THRESH &&
+ dir == IIO_EV_DIR_RISING)
+ return sprintf(label, "DOS overrange\n");
+ if (type == IIO_EV_TYPE_MAG)
+ return sprintf(label, "DOS mismatch\n");
+ }
+ if (chan->channel == 1 || chan->channel == 2)
+ return sprintf(label, "clipped\n");
+ }
+
+ return -EINVAL;
+}
+
+static int ad2s1210_debugfs_reg_access(struct iio_dev *indio_dev,
+ unsigned int reg, unsigned int writeval,
+ unsigned int *readval)
+{
+ struct ad2s1210_state *st = iio_priv(indio_dev);
+
+ guard(mutex)(&st->lock);
+
+ if (readval)
+ return regmap_read(st->regmap, reg, readval);
+
+ return regmap_write(st->regmap, reg, writeval);
+}
+
+static irqreturn_t ad2s1210_trigger_handler(int irq, void *p)
+{
+ struct iio_poll_func *pf = p;
+ struct iio_dev *indio_dev = pf->indio_dev;
+ struct ad2s1210_state *st = iio_priv(indio_dev);
+ size_t chan = 0;
+ int ret;
+
+ guard(mutex)(&st->lock);
+
+ memset(&st->scan, 0, sizeof(st->scan));
+ ad2s1210_toggle_sample_line(st);
+
+ if (test_bit(0, indio_dev->active_scan_mask)) {
+ ret = ad2s1210_set_mode(st, MOD_POS);
+ if (ret < 0)
+ goto error_ret;
+
+ ret = spi_read(st->sdev, &st->sample, 3);
+ if (ret < 0)
+ goto error_ret;
+
+ memcpy(&st->scan.chan[chan++], &st->sample.raw, 2);
+ }
+
+ if (test_bit(1, indio_dev->active_scan_mask)) {
+ ret = ad2s1210_set_mode(st, MOD_VEL);
+ if (ret < 0)
+ goto error_ret;
+
+ ret = spi_read(st->sdev, &st->sample, 3);
+ if (ret < 0)
+ goto error_ret;
+
+ memcpy(&st->scan.chan[chan++], &st->sample.raw, 2);
+ }
+
+ ad2s1210_push_events(indio_dev, st->sample.fault, pf->timestamp);
+ iio_push_to_buffers_with_timestamp(indio_dev, &st->scan, pf->timestamp);
+
+error_ret:
+ iio_trigger_notify_done(indio_dev->trig);
+
+ return IRQ_HANDLED;
+}
+
+static const struct iio_info ad2s1210_info = {
+ .event_attrs = &ad2s1210_event_attribute_group,
+ .read_raw = ad2s1210_read_raw,
+ .read_avail = ad2s1210_read_avail,
+ .write_raw = ad2s1210_write_raw,
+ .read_label = ad2s1210_read_label,
+ .read_event_value = ad2s1210_read_event_value,
+ .write_event_value = ad2s1210_write_event_value,
+ .read_event_label = ad2s1210_read_event_label,
+ .debugfs_reg_access = &ad2s1210_debugfs_reg_access,
+};
+
+static int ad2s1210_setup_properties(struct ad2s1210_state *st)
+{
+ struct device *dev = &st->sdev->dev;
+ u32 val;
+ int ret;
+
+ ret = device_property_read_u32(dev, "assigned-resolution-bits", &val);
+ if (ret < 0)
+ return dev_err_probe(dev, ret,
+ "failed to read assigned-resolution-bits property\n");
+
+ if (val < 10 || val > 16)
+ return dev_err_probe(dev, -EINVAL,
+ "resolution out of range: %u\n", val);
+
+ st->resolution = (val - 10) >> 1;
+ /*
+ * These are values that correlate to the hysteresis bit in the Control
+ * register. 0 = disabled, 1 = enabled. When enabled, the actual
+ * hysteresis is +/- 1 LSB of the raw position value. Which bit is the
+ * LSB depends on the specified resolution.
+ */
+ st->hysteresis_available[0] = 0;
+ st->hysteresis_available[1] = 1 << (2 * (AD2S1210_RES_16 -
+ st->resolution));
+
+ return 0;
+}
+
+static int ad2s1210_setup_clocks(struct ad2s1210_state *st)
+{
+ struct device *dev = &st->sdev->dev;
+ struct clk *clk;
+
+ clk = devm_clk_get_enabled(dev, NULL);
+ if (IS_ERR(clk))
+ return dev_err_probe(dev, PTR_ERR(clk), "failed to get clock\n");
+
+ st->clkin_hz = clk_get_rate(clk);
+ if (st->clkin_hz < AD2S1210_MIN_CLKIN || st->clkin_hz > AD2S1210_MAX_CLKIN)
+ return dev_err_probe(dev, -EINVAL,
+ "clock frequency out of range: %lu\n",
+ st->clkin_hz);
+
+ return 0;
+}
+
+static int ad2s1210_setup_gpios(struct ad2s1210_state *st)
+{
+ struct device *dev = &st->sdev->dev;
+ struct gpio_descs *resolution_gpios;
+ DECLARE_BITMAP(bitmap, 2);
+ int ret;
+
+ /* should not be sampling on startup */
+ st->sample_gpio = devm_gpiod_get(dev, "sample", GPIOD_OUT_LOW);
+ if (IS_ERR(st->sample_gpio))
+ return dev_err_probe(dev, PTR_ERR(st->sample_gpio),
+ "failed to request sample GPIO\n");
+
+ /* both pins high means that we start in config mode */
+ st->mode_gpios = devm_gpiod_get_array(dev, "mode", GPIOD_OUT_HIGH);
+ if (IS_ERR(st->mode_gpios))
+ return dev_err_probe(dev, PTR_ERR(st->mode_gpios),
+ "failed to request mode GPIOs\n");
+
+ if (st->mode_gpios->ndescs != 2)
+ return dev_err_probe(dev, -EINVAL,
+ "requires exactly 2 mode-gpios\n");
+
+ /*
+ * If resolution gpios are provided, they get set to the required
+ * resolution, otherwise it is assumed the RES0 and RES1 pins are
+ * hard-wired to match the resolution indicated in the devicetree.
+ */
+ resolution_gpios = devm_gpiod_get_array_optional(dev, "resolution",
+ GPIOD_ASIS);
+ if (IS_ERR(resolution_gpios))
+ return dev_err_probe(dev, PTR_ERR(resolution_gpios),
+ "failed to request resolution GPIOs\n");
+
+ if (resolution_gpios) {
+ if (resolution_gpios->ndescs != 2)
+ return dev_err_probe(dev, -EINVAL,
+ "requires exactly 2 resolution-gpios\n");
+
+ bitmap[0] = st->resolution;
+
+ ret = gpiod_set_array_value(resolution_gpios->ndescs,
+ resolution_gpios->desc,
+ resolution_gpios->info,
+ bitmap);
+ if (ret < 0)
+ return dev_err_probe(dev, ret,
+ "failed to set resolution gpios\n");
+ }
+
+ return 0;
+}
+
+static const struct regmap_range ad2s1210_regmap_readable_ranges[] = {
+ regmap_reg_range(AD2S1210_REG_POSITION_MSB, AD2S1210_REG_VELOCITY_LSB),
+ regmap_reg_range(AD2S1210_REG_LOS_THRD, AD2S1210_REG_LOT_LOW_THRD),
+ regmap_reg_range(AD2S1210_REG_EXCIT_FREQ, AD2S1210_REG_CONTROL),
+ regmap_reg_range(AD2S1210_REG_FAULT, AD2S1210_REG_FAULT),
+};
+
+static const struct regmap_access_table ad2s1210_regmap_rd_table = {
+ .yes_ranges = ad2s1210_regmap_readable_ranges,
+ .n_yes_ranges = ARRAY_SIZE(ad2s1210_regmap_readable_ranges),
+};
+
+static const struct regmap_range ad2s1210_regmap_writeable_ranges[] = {
+ regmap_reg_range(AD2S1210_REG_LOS_THRD, AD2S1210_REG_LOT_LOW_THRD),
+ regmap_reg_range(AD2S1210_REG_EXCIT_FREQ, AD2S1210_REG_CONTROL),
+ regmap_reg_range(AD2S1210_REG_SOFT_RESET, AD2S1210_REG_SOFT_RESET),
+ regmap_reg_range(AD2S1210_REG_FAULT, AD2S1210_REG_FAULT),
+};
+
+static const struct regmap_access_table ad2s1210_regmap_wr_table = {
+ .yes_ranges = ad2s1210_regmap_writeable_ranges,
+ .n_yes_ranges = ARRAY_SIZE(ad2s1210_regmap_writeable_ranges),
+};
+
+static int ad2s1210_setup_regmap(struct ad2s1210_state *st)
+{
+ struct device *dev = &st->sdev->dev;
+ const struct regmap_config config = {
+ .reg_bits = 8,
+ .val_bits = 8,
+ .disable_locking = true,
+ .reg_read = ad2s1210_regmap_reg_read,
+ .reg_write = ad2s1210_regmap_reg_write,
+ .rd_table = &ad2s1210_regmap_rd_table,
+ .wr_table = &ad2s1210_regmap_wr_table,
+ .can_sleep = true,
+ };
+
+ st->regmap = devm_regmap_init(dev, NULL, st, &config);
+ if (IS_ERR(st->regmap))
+ return dev_err_probe(dev, PTR_ERR(st->regmap),
+ "failed to allocate register map\n");
+
+ return 0;
+}
+
+static int ad2s1210_probe(struct spi_device *spi)
+{
+ struct iio_dev *indio_dev;
+ struct ad2s1210_state *st;
+ int ret;
+
+ indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*st));
+ if (!indio_dev)
+ return -ENOMEM;
+ st = iio_priv(indio_dev);
+
+ mutex_init(&st->lock);
+ st->sdev = spi;
+
+ ret = ad2s1210_setup_properties(st);
+ if (ret < 0)
+ return ret;
+
+ ret = ad2s1210_setup_clocks(st);
+ if (ret < 0)
+ return ret;
+
+ ret = ad2s1210_setup_gpios(st);
+ if (ret < 0)
+ return ret;
+
+ ret = ad2s1210_setup_regmap(st);
+ if (ret < 0)
+ return ret;
+
+ ret = ad2s1210_initial(st);
+ if (ret < 0)
+ return ret;
+
+ indio_dev->info = &ad2s1210_info;
+ indio_dev->modes = INDIO_DIRECT_MODE;
+ indio_dev->channels = ad2s1210_channels;
+ indio_dev->num_channels = ARRAY_SIZE(ad2s1210_channels);
+ indio_dev->name = spi_get_device_id(spi)->name;
+
+ ret = devm_iio_triggered_buffer_setup(&spi->dev, indio_dev,
+ &iio_pollfunc_store_time,
+ &ad2s1210_trigger_handler, NULL);
+ if (ret < 0)
+ return dev_err_probe(&spi->dev, ret,
+ "iio triggered buffer setup failed\n");
+
+ return devm_iio_device_register(&spi->dev, indio_dev);
+}
+
+static const struct of_device_id ad2s1210_of_match[] = {
+ { .compatible = "adi,ad2s1210", },
+ { }
+};
+MODULE_DEVICE_TABLE(of, ad2s1210_of_match);
+
+static const struct spi_device_id ad2s1210_id[] = {
+ { "ad2s1210" },
+ {}
+};
+MODULE_DEVICE_TABLE(spi, ad2s1210_id);
+
+static struct spi_driver ad2s1210_driver = {
+ .driver = {
+ .name = DRV_NAME,
+ .of_match_table = of_match_ptr(ad2s1210_of_match),
+ },
+ .probe = ad2s1210_probe,
+ .id_table = ad2s1210_id,
+};
+module_spi_driver(ad2s1210_driver);
+
+MODULE_AUTHOR("Graff Yang <[email protected]>");
+MODULE_DESCRIPTION("Analog Devices AD2S1210 Resolver to Digital SPI driver");
+MODULE_LICENSE("GPL v2");
diff --git a/drivers/staging/iio/Documentation/sysfs-bus-iio-resolver-ad2s1210 b/drivers/staging/iio/Documentation/sysfs-bus-iio-resolver-ad2s1210
deleted file mode 100644
index f92c79342b93..000000000000
--- a/drivers/staging/iio/Documentation/sysfs-bus-iio-resolver-ad2s1210
+++ /dev/null
@@ -1,27 +0,0 @@
-What: /sys/bus/iio/devices/iio:deviceX/events/in_altvoltage0_mag_rising_reset_max
-KernelVersion: 6.7
-Contact: [email protected]
-Description:
- Reading returns the current Degradation of Signal Reset Maximum
- Threshold value in millivolts. Writing sets the value.
-
-What: /sys/bus/iio/devices/iio:deviceX/events/in_altvoltage0_mag_rising_reset_max_available
-KernelVersion: 6.7
-Contact: [email protected]
-Description:
- Reading returns the allowable voltage range for
- in_altvoltage0_mag_rising_reset_max.
-
-What: /sys/bus/iio/devices/iio:deviceX/events/in_altvoltage0_mag_rising_reset_min
-KernelVersion: 6.7
-Contact: [email protected]
-Description:
- Reading returns the current Degradation of Signal Reset Minimum
- Threshold value in millivolts. Writing sets the value.
-
-What: /sys/bus/iio/devices/iio:deviceX/events/in_altvoltage0_mag_rising_reset_min_available
-KernelVersion: 6.7
-Contact: [email protected]
-Description:
- Reading returns the allowable voltage range for
- in_altvoltage0_mag_rising_reset_min.
diff --git a/drivers/staging/iio/Kconfig b/drivers/staging/iio/Kconfig
index d3968fe2ebb8..a60631c1f449 100644
--- a/drivers/staging/iio/Kconfig
+++ b/drivers/staging/iio/Kconfig
@@ -10,6 +10,5 @@ source "drivers/staging/iio/adc/Kconfig"
source "drivers/staging/iio/addac/Kconfig"
source "drivers/staging/iio/frequency/Kconfig"
source "drivers/staging/iio/impedance-analyzer/Kconfig"
-source "drivers/staging/iio/resolver/Kconfig"
endmenu
diff --git a/drivers/staging/iio/Makefile b/drivers/staging/iio/Makefile
index c50f1019f829..628583535393 100644
--- a/drivers/staging/iio/Makefile
+++ b/drivers/staging/iio/Makefile
@@ -8,4 +8,3 @@ obj-y += adc/
obj-y += addac/
obj-y += frequency/
obj-y += impedance-analyzer/
-obj-y += resolver/
diff --git a/drivers/staging/iio/resolver/Kconfig b/drivers/staging/iio/resolver/Kconfig
deleted file mode 100644
index bebb35822c9e..000000000000
--- a/drivers/staging/iio/resolver/Kconfig
+++ /dev/null
@@ -1,19 +0,0 @@
-# SPDX-License-Identifier: GPL-2.0
-#
-# Resolver/Synchro drivers
-#
-menu "Resolver to digital converters"
-
-config AD2S1210
- tristate "Analog Devices ad2s1210 driver"
- depends on SPI
- depends on COMMON_CLK
- depends on GPIOLIB || COMPILE_TEST
- help
- Say yes here to build support for Analog Devices spi resolver
- to digital converters, ad2s1210, provides direct access via sysfs.
-
- To compile this driver as a module, choose M here: the
- module will be called ad2s1210.
-
-endmenu
diff --git a/drivers/staging/iio/resolver/Makefile b/drivers/staging/iio/resolver/Makefile
deleted file mode 100644
index 398631f7e79b..000000000000
--- a/drivers/staging/iio/resolver/Makefile
+++ /dev/null
@@ -1,6 +0,0 @@
-# SPDX-License-Identifier: GPL-2.0
-#
-# Makefile for Resolver/Synchro drivers
-#
-
-obj-$(CONFIG_AD2S1210) += ad2s1210.o
diff --git a/drivers/staging/iio/resolver/ad2s1210.c b/drivers/staging/iio/resolver/ad2s1210.c
deleted file mode 100644
index bd4a90c222b5..000000000000
--- a/drivers/staging/iio/resolver/ad2s1210.c
+++ /dev/null
@@ -1,1522 +0,0 @@
-// SPDX-License-Identifier: GPL-2.0
-/*
- * ad2s1210.c support for the ADI Resolver to Digital Converters: AD2S1210
- *
- * Copyright (c) 2010-2010 Analog Devices Inc.
- * Copyright (c) 2023 BayLibre, SAS
- *
- * Device register to IIO ABI mapping:
- *
- * Register | Addr | IIO ABI (sysfs)
- * ----------------------------|------|-------------------------------------------
- * DOS Overrange Threshold | 0x89 | events/in_altvoltage0_thresh_rising_value
- * DOS Mismatch Threshold | 0x8A | events/in_altvoltage0_mag_rising_value
- * DOS Reset Maximum Threshold | 0x8B | events/in_altvoltage0_mag_rising_reset_max
- * DOS Reset Minimum Threshold | 0x8C | events/in_altvoltage0_mag_rising_reset_min
- * LOT High Threshold | 0x8D | events/in_angl1_thresh_rising_value
- * LOT Low Threshold [1] | 0x8E | events/in_angl1_thresh_rising_hysteresis
- * Excitation Frequency | 0x91 | out_altvoltage0_frequency
- * Control | 0x92 | *as bit fields*
- * Phase lock range | D5 | events/in_phase0_mag_rising_value
- * Hysteresis | D4 | in_angl0_hysteresis
- * Encoder resolution | D3:2 | *not implemented*
- * Resolution | D1:0 | *device tree: assigned-resolution-bits*
- * Soft Reset | 0xF0 | [2]
- * Fault | 0xFF | *not implemented*
- *
- * [1]: The value written to the LOT low register is high value minus the
- * hysteresis.
- * [2]: Soft reset is performed when `out_altvoltage0_frequency` is written.
- *
- * Fault to event mapping:
- *
- * Fault | | Channel | Type | Direction
- * ----------------------------------------|----|---------------------------------
- * Sine/cosine inputs clipped [3] | D7 | altvoltage1 | mag | either
- * Sine/cosine inputs below LOS | D6 | altvoltage0 | thresh | falling
- * Sine/cosine inputs exceed DOS overrange | D5 | altvoltage0 | thresh | rising
- * Sine/cosine inputs exceed DOS mismatch | D4 | altvoltage0 | mag | rising
- * Tracking error exceeds LOT | D3 | angl1 | thresh | rising
- * Velocity exceeds maximum tracking rate | D2 | anglvel0 | mag | rising
- * Phase error exceeds phase lock range | D1 | phase0 | mag | rising
- * Configuration parity error | D0 | *writes to kernel log*
- *
- * [3]: The chip does not differentiate between fault on sine vs. cosine so
- * there will also be an event on the altvoltage2 channel.
- */
-
-#include <linux/bitfield.h>
-#include <linux/bits.h>
-#include <linux/cleanup.h>
-#include <linux/clk.h>
-#include <linux/delay.h>
-#include <linux/device.h>
-#include <linux/gpio/consumer.h>
-#include <linux/module.h>
-#include <linux/mutex.h>
-#include <linux/of.h>
-#include <linux/regmap.h>
-#include <linux/slab.h>
-#include <linux/spi/spi.h>
-#include <linux/sysfs.h>
-#include <linux/types.h>
-
-#include <linux/iio/buffer.h>
-#include <linux/iio/events.h>
-#include <linux/iio/iio.h>
-#include <linux/iio/sysfs.h>
-#include <linux/iio/trigger_consumer.h>
-#include <linux/iio/triggered_buffer.h>
-
-#define DRV_NAME "ad2s1210"
-
-/* control register flags */
-#define AD2S1210_ADDRESS_DATA BIT(7)
-#define AD2S1210_PHASE_LOCK_RANGE_44 BIT(5)
-#define AD2S1210_ENABLE_HYSTERESIS BIT(4)
-#define AD2S1210_SET_ENRES GENMASK(3, 2)
-#define AD2S1210_SET_RES GENMASK(1, 0)
-
-/* fault register flags */
-#define AD2S1210_FAULT_CLIP BIT(7)
-#define AD2S1210_FAULT_LOS BIT(6)
-#define AD2S1210_FAULT_DOS_OVR BIT(5)
-#define AD2S1210_FAULT_DOS_MIS BIT(4)
-#define AD2S1210_FAULT_LOT BIT(3)
-#define AD2S1210_FAULT_VELOCITY BIT(2)
-#define AD2S1210_FAULT_PHASE BIT(1)
-#define AD2S1210_FAULT_CONFIG_PARITY BIT(0)
-
-#define AD2S1210_REG_POSITION_MSB 0x80
-#define AD2S1210_REG_POSITION_LSB 0x81
-#define AD2S1210_REG_VELOCITY_MSB 0x82
-#define AD2S1210_REG_VELOCITY_LSB 0x83
-#define AD2S1210_REG_LOS_THRD 0x88
-#define AD2S1210_REG_DOS_OVR_THRD 0x89
-#define AD2S1210_REG_DOS_MIS_THRD 0x8A
-#define AD2S1210_REG_DOS_RST_MAX_THRD 0x8B
-#define AD2S1210_REG_DOS_RST_MIN_THRD 0x8C
-#define AD2S1210_REG_LOT_HIGH_THRD 0x8D
-#define AD2S1210_REG_LOT_LOW_THRD 0x8E
-#define AD2S1210_REG_EXCIT_FREQ 0x91
-#define AD2S1210_REG_CONTROL 0x92
-#define AD2S1210_REG_SOFT_RESET 0xF0
-#define AD2S1210_REG_FAULT 0xFF
-
-#define AD2S1210_MIN_CLKIN 6144000
-#define AD2S1210_MAX_CLKIN 10240000
-#define AD2S1210_MIN_EXCIT 2000
-#define AD2S1210_DEF_EXCIT 10000
-#define AD2S1210_MAX_EXCIT 20000
-#define AD2S1210_MIN_FCW 0x4
-#define AD2S1210_MAX_FCW 0x50
-
-/* 44 degrees ~= 0.767945 radians */
-#define PHASE_44_DEG_TO_RAD_INT 0
-#define PHASE_44_DEG_TO_RAD_MICRO 767945
-/* 360 degrees ~= 6.283185 radians */
-#define PHASE_360_DEG_TO_RAD_INT 6
-#define PHASE_360_DEG_TO_RAD_MICRO 283185
-
-/* Threshold voltage registers have 1 LSB == 38 mV */
-#define THRESHOLD_MILLIVOLT_PER_LSB 38
-/* max voltage for threshold registers is 0x7F * 38 mV */
-#define THRESHOLD_RANGE_STR "[0 38 4826]"
-
-#define FAULT_ONESHOT(bit, new, old) (new & bit && !(old & bit))
-
-enum ad2s1210_mode {
- MOD_POS = 0b00,
- MOD_VEL = 0b01,
- MOD_RESERVED = 0b10,
- MOD_CONFIG = 0b11,
-};
-
-enum ad2s1210_resolution {
- AD2S1210_RES_10 = 0b00,
- AD2S1210_RES_12 = 0b01,
- AD2S1210_RES_14 = 0b10,
- AD2S1210_RES_16 = 0b11,
-};
-
-struct ad2s1210_state {
- struct mutex lock;
- struct spi_device *sdev;
- /** GPIO pin connected to SAMPLE line. */
- struct gpio_desc *sample_gpio;
- /** GPIO pins connected to A0 and A1 lines. */
- struct gpio_descs *mode_gpios;
- /** Used to access config registers. */
- struct regmap *regmap;
- /** The external oscillator frequency in Hz. */
- unsigned long clkin_hz;
- /** Available raw hysteresis values based on resolution. */
- int hysteresis_available[2];
- /** The selected resolution */
- enum ad2s1210_resolution resolution;
- /** Copy of fault register from the previous read. */
- u8 prev_fault_flags;
- /** For reading raw sample value via SPI. */
- struct {
- __be16 raw;
- u8 fault;
- } sample __aligned(IIO_DMA_MINALIGN);
- /** Scan buffer */
- struct {
- __be16 chan[2];
- /* Ensure timestamp is naturally aligned. */
- s64 timestamp __aligned(8);
- } scan;
- /** SPI transmit buffer. */
- u8 rx[2];
- /** SPI receive buffer. */
- u8 tx[2];
-};
-
-static int ad2s1210_set_mode(struct ad2s1210_state *st, enum ad2s1210_mode mode)
-{
- struct gpio_descs *gpios = st->mode_gpios;
- DECLARE_BITMAP(bitmap, 2);
-
- bitmap[0] = mode;
-
- return gpiod_set_array_value(gpios->ndescs, gpios->desc, gpios->info,
- bitmap);
-}
-
-/*
- * Writes the given data to the given register address.
- *
- * If the mode is configurable, the device will first be placed in
- * configuration mode.
- */
-static int ad2s1210_regmap_reg_write(void *context, unsigned int reg,
- unsigned int val)
-{
- struct ad2s1210_state *st = context;
- struct spi_transfer xfers[] = {
- {
- .len = 1,
- .rx_buf = &st->rx[0],
- .tx_buf = &st->tx[0],
- .cs_change = 1,
- }, {
- .len = 1,
- .rx_buf = &st->rx[1],
- .tx_buf = &st->tx[1],
- },
- };
- int ret;
-
- /* values can only be 7 bits, the MSB indicates an address */
- if (val & ~0x7F)
- return -EINVAL;
-
- st->tx[0] = reg;
- st->tx[1] = val;
-
- ret = ad2s1210_set_mode(st, MOD_CONFIG);
- if (ret < 0)
- return ret;
-
- ret = spi_sync_transfer(st->sdev, xfers, ARRAY_SIZE(xfers));
- if (ret < 0)
- return ret;
-
- /* soft reset also clears the fault register */
- if (reg == AD2S1210_REG_SOFT_RESET)
- st->prev_fault_flags = 0;
-
- return 0;
-}
-
-/*
- * Reads value from one of the registers.
- *
- * If the mode is configurable, the device will first be placed in
- * configuration mode.
- */
-static int ad2s1210_regmap_reg_read(void *context, unsigned int reg,
- unsigned int *val)
-{
- struct ad2s1210_state *st = context;
- struct spi_transfer xfers[] = {
- {
- .len = 1,
- .rx_buf = &st->rx[0],
- .tx_buf = &st->tx[0],
- .cs_change = 1,
- }, {
- .len = 1,
- .rx_buf = &st->rx[1],
- .tx_buf = &st->tx[1],
- },
- };
- int ret;
-
- ret = ad2s1210_set_mode(st, MOD_CONFIG);
- if (ret < 0)
- return ret;
-
- st->tx[0] = reg;
- /*
- * Must be valid register address here otherwise this could write data.
- * It doesn't matter which one as long as reading doesn't have side-
- * effects.
- */
- st->tx[1] = AD2S1210_REG_CONTROL;
-
- ret = spi_sync_transfer(st->sdev, xfers, ARRAY_SIZE(xfers));
- if (ret < 0)
- return ret;
-
- /* reading the fault register also clears it */
- if (reg == AD2S1210_REG_FAULT)
- st->prev_fault_flags = 0;
-
- /*
- * If the D7 bit is set on any read/write register, it indicates a
- * parity error. The fault register is read-only and the D7 bit means
- * something else there.
- */
- if (reg != AD2S1210_REG_FAULT && st->rx[1] & AD2S1210_ADDRESS_DATA)
- return -EBADMSG;
-
- *val = st->rx[1];
-
- return 0;
-}
-
-/*
- * Toggles the SAMPLE line on the AD2S1210 to latch in the current position,
- * velocity, and faults.
- *
- * Must be called with lock held.
- */
-static void ad2s1210_toggle_sample_line(struct ad2s1210_state *st)
-{
- /*
- * Datasheet specifies minimum hold time t16 = 2 * tck + 20 ns. So the
- * longest time needed is when CLKIN is 6.144 MHz, in which case t16
- * ~= 350 ns. The same delay is also needed before re-asserting the
- * SAMPLE line.
- */
- gpiod_set_value(st->sample_gpio, 1);
- ndelay(350);
- gpiod_set_value(st->sample_gpio, 0);
- ndelay(350);
-}
-
-/*
- * Sets the excitation frequency and performs software reset.
- *
- * Must be called with lock held.
- */
-static int ad2s1210_reinit_excitation_frequency(struct ad2s1210_state *st,
- u16 fexcit)
-{
- /* Map resolution to settle time in milliseconds. */
- static const int track_time_ms[] = { 10, 20, 25, 60 };
- unsigned int ignored;
- int ret;
- u8 fcw;
-
- fcw = fexcit * (1 << 15) / st->clkin_hz;
- if (fcw < AD2S1210_MIN_FCW || fcw > AD2S1210_MAX_FCW)
- return -ERANGE;
-
- ret = regmap_write(st->regmap, AD2S1210_REG_EXCIT_FREQ, fcw);
- if (ret < 0)
- return ret;
-
- /*
- * Software reset reinitializes the excitation frequency output.
- * It does not reset any of the configuration registers.
- */
- ret = regmap_write(st->regmap, AD2S1210_REG_SOFT_RESET, 0);
- if (ret < 0)
- return ret;
-
- /*
- * Soft reset always triggers some faults due the change in the output
- * signal so clear the faults too. We need to delay for some time
- * (what datasheet calls t[track]) to allow things to settle before
- * clearing the faults.
- */
- msleep(track_time_ms[st->resolution] * 8192000 / st->clkin_hz);
-
- /* Reading the fault register clears the faults. */
- ret = regmap_read(st->regmap, AD2S1210_REG_FAULT, &ignored);
- if (ret < 0)
- return ret;
-
- /* Have to toggle sample line to get fault output pins to reset. */
- ad2s1210_toggle_sample_line(st);
-
- return 0;
-}
-
-static void ad2s1210_push_events(struct iio_dev *indio_dev,
- u8 flags, s64 timestamp)
-{
- struct ad2s1210_state *st = iio_priv(indio_dev);
-
- /* Sine/cosine inputs clipped */
- if (FAULT_ONESHOT(AD2S1210_FAULT_CLIP, flags, st->prev_fault_flags)) {
- /*
- * The chip does not differentiate between fault on sine vs.
- * cosine channel so we just send an event on both channels.
- */
- iio_push_event(indio_dev,
- IIO_UNMOD_EVENT_CODE(IIO_ALTVOLTAGE, 1,
- IIO_EV_TYPE_MAG,
- IIO_EV_DIR_EITHER),
- timestamp);
- iio_push_event(indio_dev,
- IIO_UNMOD_EVENT_CODE(IIO_ALTVOLTAGE, 2,
- IIO_EV_TYPE_MAG,
- IIO_EV_DIR_EITHER),
- timestamp);
- }
-
- /* Sine/cosine inputs below LOS threshold */
- if (FAULT_ONESHOT(AD2S1210_FAULT_LOS, flags, st->prev_fault_flags))
- iio_push_event(indio_dev,
- IIO_UNMOD_EVENT_CODE(IIO_ALTVOLTAGE, 0,
- IIO_EV_TYPE_THRESH,
- IIO_EV_DIR_FALLING),
- timestamp);
-
- /* Sine/cosine inputs exceed DOS overrange threshold */
- if (FAULT_ONESHOT(AD2S1210_FAULT_DOS_OVR, flags, st->prev_fault_flags))
- iio_push_event(indio_dev,
- IIO_UNMOD_EVENT_CODE(IIO_ALTVOLTAGE, 0,
- IIO_EV_TYPE_THRESH,
- IIO_EV_DIR_RISING),
- timestamp);
-
- /* Sine/cosine inputs exceed DOS mismatch threshold */
- if (FAULT_ONESHOT(AD2S1210_FAULT_DOS_MIS, flags, st->prev_fault_flags))
- iio_push_event(indio_dev,
- IIO_UNMOD_EVENT_CODE(IIO_ALTVOLTAGE, 0,
- IIO_EV_TYPE_MAG,
- IIO_EV_DIR_RISING),
- timestamp);
-
- /* Tracking error exceeds LOT threshold */
- if (FAULT_ONESHOT(AD2S1210_FAULT_LOT, flags, st->prev_fault_flags))
- iio_push_event(indio_dev,
- IIO_UNMOD_EVENT_CODE(IIO_ANGL, 1,
- IIO_EV_TYPE_THRESH,
- IIO_EV_DIR_RISING),
- timestamp);
-
- /* Velocity exceeds maximum tracking rate */
- if (FAULT_ONESHOT(AD2S1210_FAULT_VELOCITY, flags, st->prev_fault_flags))
- iio_push_event(indio_dev,
- IIO_UNMOD_EVENT_CODE(IIO_ANGL_VEL, 0,
- IIO_EV_TYPE_THRESH,
- IIO_EV_DIR_RISING),
- timestamp);
-
- /* Phase error exceeds phase lock range */
- if (FAULT_ONESHOT(AD2S1210_FAULT_PHASE, flags, st->prev_fault_flags))
- iio_push_event(indio_dev,
- IIO_UNMOD_EVENT_CODE(IIO_PHASE, 0,
- IIO_EV_TYPE_MAG,
- IIO_EV_DIR_RISING),
- timestamp);
-
- /* Configuration parity error */
- if (FAULT_ONESHOT(AD2S1210_FAULT_CONFIG_PARITY, flags,
- st->prev_fault_flags))
- /*
- * Userspace should also get notified of this via error return
- * when trying to write to any attribute that writes a register.
- */
- dev_err_ratelimited(&indio_dev->dev,
- "Configuration parity error\n");
-
- st->prev_fault_flags = flags;
-}
-
-static int ad2s1210_single_conversion(struct iio_dev *indio_dev,
- struct iio_chan_spec const *chan,
- int *val)
-{
- struct ad2s1210_state *st = iio_priv(indio_dev);
- s64 timestamp;
- int ret;
-
- guard(mutex)(&st->lock);
-
- ad2s1210_toggle_sample_line(st);
- timestamp = iio_get_time_ns(indio_dev);
-
- switch (chan->type) {
- case IIO_ANGL:
- ret = ad2s1210_set_mode(st, MOD_POS);
- break;
- case IIO_ANGL_VEL:
- ret = ad2s1210_set_mode(st, MOD_VEL);
- break;
- default:
- return -EINVAL;
- }
- if (ret < 0)
- return ret;
- ret = spi_read(st->sdev, &st->sample, 3);
- if (ret < 0)
- return ret;
-
- switch (chan->type) {
- case IIO_ANGL:
- *val = be16_to_cpu(st->sample.raw);
- ret = IIO_VAL_INT;
- break;
- case IIO_ANGL_VEL:
- *val = (s16)be16_to_cpu(st->sample.raw);
- ret = IIO_VAL_INT;
- break;
- default:
- return -EINVAL;
- }
-
- ad2s1210_push_events(indio_dev, st->sample.fault, timestamp);
-
- return ret;
-}
-
-static int ad2s1210_get_hysteresis(struct ad2s1210_state *st, int *val)
-{
- int ret;
-
- guard(mutex)(&st->lock);
- ret = regmap_test_bits(st->regmap, AD2S1210_REG_CONTROL,
- AD2S1210_ENABLE_HYSTERESIS);
- if (ret < 0)
- return ret;
-
- *val = ret << (2 * (AD2S1210_RES_16 - st->resolution));
- return IIO_VAL_INT;
-}
-
-static int ad2s1210_set_hysteresis(struct ad2s1210_state *st, int val)
-{
- guard(mutex)(&st->lock);
- return regmap_update_bits(st->regmap, AD2S1210_REG_CONTROL,
- AD2S1210_ENABLE_HYSTERESIS,
- val ? AD2S1210_ENABLE_HYSTERESIS : 0);
-}
-
-static int ad2s1210_get_phase_lock_range(struct ad2s1210_state *st,
- int *val, int *val2)
-{
- int ret;
-
- guard(mutex)(&st->lock);
- ret = regmap_test_bits(st->regmap, AD2S1210_REG_CONTROL,
- AD2S1210_PHASE_LOCK_RANGE_44);
- if (ret < 0)
- return ret;
-
- if (ret) {
- /* 44 degrees as radians */
- *val = PHASE_44_DEG_TO_RAD_INT;
- *val2 = PHASE_44_DEG_TO_RAD_MICRO;
- } else {
- /* 360 degrees as radians */
- *val = PHASE_360_DEG_TO_RAD_INT;
- *val2 = PHASE_360_DEG_TO_RAD_MICRO;
- }
-
- return IIO_VAL_INT_PLUS_MICRO;
-}
-
-static int ad2s1210_set_phase_lock_range(struct ad2s1210_state *st,
- int val, int val2)
-{
- int deg;
-
- /* convert radians to degrees - only two allowable values */
- if (val == PHASE_44_DEG_TO_RAD_INT && val2 == PHASE_44_DEG_TO_RAD_MICRO)
- deg = 44;
- else if (val == PHASE_360_DEG_TO_RAD_INT &&
- val2 == PHASE_360_DEG_TO_RAD_MICRO)
- deg = 360;
- else
- return -EINVAL;
-
- guard(mutex)(&st->lock);
- return regmap_update_bits(st->regmap, AD2S1210_REG_CONTROL,
- AD2S1210_PHASE_LOCK_RANGE_44,
- deg == 44 ? AD2S1210_PHASE_LOCK_RANGE_44 : 0);
-}
-
-/* map resolution to microradians/LSB for LOT registers */
-static const int ad2s1210_lot_threshold_urad_per_lsb[] = {
- 6184, /* 10-bit: ~0.35 deg/LSB, 45 deg max */
- 2473, /* 12-bit: ~0.14 deg/LSB, 18 deg max */
- 1237, /* 14-bit: ~0.07 deg/LSB, 9 deg max */
- 1237, /* 16-bit: same as 14-bit */
-};
-
-static int ad2s1210_get_voltage_threshold(struct ad2s1210_state *st,
- unsigned int reg, int *val)
-{
- unsigned int reg_val;
- int ret;
-
- guard(mutex)(&st->lock);
- ret = regmap_read(st->regmap, reg, ®_val);
- if (ret < 0)
- return ret;
-
- *val = reg_val * THRESHOLD_MILLIVOLT_PER_LSB;
- return IIO_VAL_INT;
-}
-
-static int ad2s1210_set_voltage_threshold(struct ad2s1210_state *st,
- unsigned int reg, int val)
-{
- unsigned int reg_val;
-
- reg_val = val / THRESHOLD_MILLIVOLT_PER_LSB;
-
- guard(mutex)(&st->lock);
- return regmap_write(st->regmap, reg, reg_val);
-}
-
-static int ad2s1210_get_lot_high_threshold(struct ad2s1210_state *st,
- int *val, int *val2)
-{
- unsigned int reg_val;
- int ret;
-
- guard(mutex)(&st->lock);
- ret = regmap_read(st->regmap, AD2S1210_REG_LOT_HIGH_THRD, ®_val);
- if (ret < 0)
- return ret;
-
- *val = 0;
- *val2 = reg_val * ad2s1210_lot_threshold_urad_per_lsb[st->resolution];
- return IIO_VAL_INT_PLUS_MICRO;
-}
-
-static int ad2s1210_set_lot_high_threshold(struct ad2s1210_state *st,
- int val, int val2)
-{
- unsigned int high_reg_val, low_reg_val, hysteresis;
- int ret;
-
- /* all valid values are between 0 and pi/4 radians */
- if (val != 0)
- return -EINVAL;
-
- guard(mutex)(&st->lock);
- /*
- * We need to read both high and low registers first so we can preserve
- * the hysteresis.
- */
- ret = regmap_read(st->regmap, AD2S1210_REG_LOT_HIGH_THRD, &high_reg_val);
- if (ret < 0)
- return ret;
-
- ret = regmap_read(st->regmap, AD2S1210_REG_LOT_LOW_THRD, &low_reg_val);
- if (ret < 0)
- return ret;
-
- hysteresis = high_reg_val - low_reg_val;
- high_reg_val = val2 / ad2s1210_lot_threshold_urad_per_lsb[st->resolution];
- low_reg_val = high_reg_val - hysteresis;
-
- ret = regmap_write(st->regmap, AD2S1210_REG_LOT_HIGH_THRD, high_reg_val);
- if (ret < 0)
- return ret;
-
- return regmap_write(st->regmap, AD2S1210_REG_LOT_LOW_THRD, low_reg_val);
-}
-
-static int ad2s1210_get_lot_low_threshold(struct ad2s1210_state *st,
- int *val, int *val2)
-{
- unsigned int high_reg_val, low_reg_val;
- int ret;
-
- guard(mutex)(&st->lock);
-
- ret = regmap_read(st->regmap, AD2S1210_REG_LOT_HIGH_THRD, &high_reg_val);
- if (ret < 0)
- return ret;
-
- ret = regmap_read(st->regmap, AD2S1210_REG_LOT_LOW_THRD, &low_reg_val);
- if (ret < 0)
- return ret;
-
- /* sysfs value is hysteresis rather than actual low value */
- *val = 0;
- *val2 = (high_reg_val - low_reg_val) *
- ad2s1210_lot_threshold_urad_per_lsb[st->resolution];
- return IIO_VAL_INT_PLUS_MICRO;
-}
-
-static int ad2s1210_set_lot_low_threshold(struct ad2s1210_state *st,
- int val, int val2)
-{
- unsigned int reg_val, hysteresis;
- int ret;
-
- /* all valid values are between 0 and pi/4 radians */
- if (val != 0)
- return -EINVAL;
-
- hysteresis = val2 / ad2s1210_lot_threshold_urad_per_lsb[st->resolution];
-
- guard(mutex)(&st->lock);
-
- ret = regmap_read(st->regmap, AD2S1210_REG_LOT_HIGH_THRD, ®_val);
- if (ret < 0)
- return ret;
-
- return regmap_write(st->regmap, AD2S1210_REG_LOT_LOW_THRD,
- reg_val - hysteresis);
-}
-
-static int ad2s1210_get_excitation_frequency(struct ad2s1210_state *st, int *val)
-{
- unsigned int reg_val;
- int ret;
-
- guard(mutex)(&st->lock);
-
- ret = regmap_read(st->regmap, AD2S1210_REG_EXCIT_FREQ, ®_val);
- if (ret < 0)
- return ret;
-
- *val = reg_val * st->clkin_hz / (1 << 15);
- return IIO_VAL_INT;
-}
-
-static int ad2s1210_set_excitation_frequency(struct ad2s1210_state *st, int val)
-{
- if (val < AD2S1210_MIN_EXCIT || val > AD2S1210_MAX_EXCIT)
- return -EINVAL;
-
- guard(mutex)(&st->lock);
- return ad2s1210_reinit_excitation_frequency(st, val);
-}
-
-static const int ad2s1210_velocity_scale[] = {
- 17089132, /* 8.192MHz / (2*pi * 2500 / 2^15) */
- 42722830, /* 8.192MHz / (2*pi * 1000 / 2^15) */
- 85445659, /* 8.192MHz / (2*pi * 500 / 2^15) */
- 341782638, /* 8.192MHz / (2*pi * 125 / 2^15) */
-};
-
-static int ad2s1210_read_raw(struct iio_dev *indio_dev,
- struct iio_chan_spec const *chan,
- int *val,
- int *val2,
- long mask)
-{
- struct ad2s1210_state *st = iio_priv(indio_dev);
-
- switch (mask) {
- case IIO_CHAN_INFO_RAW:
- return ad2s1210_single_conversion(indio_dev, chan, val);
- case IIO_CHAN_INFO_SCALE:
- switch (chan->type) {
- case IIO_ANGL:
- /* approx 0.3 arc min converted to radians */
- *val = 0;
- *val2 = 95874;
- return IIO_VAL_INT_PLUS_NANO;
- case IIO_ANGL_VEL:
- *val = st->clkin_hz;
- *val2 = ad2s1210_velocity_scale[st->resolution];
- return IIO_VAL_FRACTIONAL;
- default:
- return -EINVAL;
- }
- case IIO_CHAN_INFO_FREQUENCY:
- switch (chan->type) {
- case IIO_ALTVOLTAGE:
- return ad2s1210_get_excitation_frequency(st, val);
- default:
- return -EINVAL;
- }
- case IIO_CHAN_INFO_HYSTERESIS:
- switch (chan->type) {
- case IIO_ANGL:
- return ad2s1210_get_hysteresis(st, val);
- default:
- return -EINVAL;
- }
- default:
- return -EINVAL;
- }
-}
-
-static int ad2s1210_read_avail(struct iio_dev *indio_dev,
- struct iio_chan_spec const *chan,
- const int **vals, int *type,
- int *length, long mask)
-{
- static const int excitation_frequency_available[] = {
- AD2S1210_MIN_EXCIT,
- 250, /* step */
- AD2S1210_MAX_EXCIT,
- };
-
- struct ad2s1210_state *st = iio_priv(indio_dev);
-
- switch (mask) {
- case IIO_CHAN_INFO_FREQUENCY:
- switch (chan->type) {
- case IIO_ALTVOLTAGE:
- *type = IIO_VAL_INT;
- *vals = excitation_frequency_available;
- return IIO_AVAIL_RANGE;
- default:
- return -EINVAL;
- }
- case IIO_CHAN_INFO_HYSTERESIS:
- switch (chan->type) {
- case IIO_ANGL:
- *vals = st->hysteresis_available;
- *type = IIO_VAL_INT;
- *length = ARRAY_SIZE(st->hysteresis_available);
- return IIO_AVAIL_LIST;
- default:
- return -EINVAL;
- }
- default:
- return -EINVAL;
- }
-}
-
-static int ad2s1210_write_raw(struct iio_dev *indio_dev,
- struct iio_chan_spec const *chan,
- int val, int val2, long mask)
-{
- struct ad2s1210_state *st = iio_priv(indio_dev);
-
- switch (mask) {
- case IIO_CHAN_INFO_FREQUENCY:
- switch (chan->type) {
- case IIO_ALTVOLTAGE:
- return ad2s1210_set_excitation_frequency(st, val);
- default:
- return -EINVAL;
- }
- case IIO_CHAN_INFO_HYSTERESIS:
- switch (chan->type) {
- case IIO_ANGL:
- return ad2s1210_set_hysteresis(st, val);
- default:
- return -EINVAL;
- }
- default:
- return -EINVAL;
- }
-}
-
-static const struct iio_event_spec ad2s1210_position_event_spec[] = {
- {
- /* Tracking error exceeds LOT threshold fault. */
- .type = IIO_EV_TYPE_THRESH,
- .dir = IIO_EV_DIR_RISING,
- .mask_separate =
- /* Loss of tracking high threshold. */
- BIT(IIO_EV_INFO_VALUE) |
- /* Loss of tracking low threshold. */
- BIT(IIO_EV_INFO_HYSTERESIS),
- },
-};
-
-static const struct iio_event_spec ad2s1210_velocity_event_spec[] = {
- {
- /* Velocity exceeds maximum tracking rate fault. */
- .type = IIO_EV_TYPE_MAG,
- .dir = IIO_EV_DIR_RISING,
- },
-};
-
-static const struct iio_event_spec ad2s1210_phase_event_spec[] = {
- {
- /* Phase error fault. */
- .type = IIO_EV_TYPE_MAG,
- .dir = IIO_EV_DIR_RISING,
- /* Phase lock range. */
- .mask_separate = BIT(IIO_EV_INFO_VALUE),
- },
-};
-
-static const struct iio_event_spec ad2s1210_monitor_signal_event_spec[] = {
- {
- /* Sine/cosine below LOS threshold fault. */
- .type = IIO_EV_TYPE_THRESH,
- .dir = IIO_EV_DIR_FALLING,
- /* Loss of signal threshold. */
- .mask_separate = BIT(IIO_EV_INFO_VALUE),
- },
- {
- /* Sine/cosine DOS overrange fault.*/
- .type = IIO_EV_TYPE_THRESH,
- .dir = IIO_EV_DIR_RISING,
- /* Degredation of signal overrange threshold. */
- .mask_separate = BIT(IIO_EV_INFO_VALUE),
- },
- {
- /* Sine/cosine DOS mismatch fault.*/
- .type = IIO_EV_TYPE_MAG,
- .dir = IIO_EV_DIR_RISING,
- .mask_separate = BIT(IIO_EV_INFO_VALUE),
- },
-};
-
-static const struct iio_event_spec ad2s1210_sin_cos_event_spec[] = {
- {
- /* Sine/cosine clipping fault. */
- .type = IIO_EV_TYPE_MAG,
- .dir = IIO_EV_DIR_EITHER,
- },
-};
-
-static const struct iio_chan_spec ad2s1210_channels[] = {
- {
- .type = IIO_ANGL,
- .indexed = 1,
- .channel = 0,
- .scan_index = 0,
- .scan_type = {
- .sign = 'u',
- .realbits = 16,
- .storagebits = 16,
- .endianness = IIO_BE,
- },
- .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
- BIT(IIO_CHAN_INFO_SCALE) |
- BIT(IIO_CHAN_INFO_HYSTERESIS),
- .info_mask_separate_available =
- BIT(IIO_CHAN_INFO_HYSTERESIS),
- }, {
- .type = IIO_ANGL_VEL,
- .indexed = 1,
- .channel = 0,
- .scan_index = 1,
- .scan_type = {
- .sign = 's',
- .realbits = 16,
- .storagebits = 16,
- .endianness = IIO_BE,
- },
- .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
- BIT(IIO_CHAN_INFO_SCALE),
- .event_spec = ad2s1210_velocity_event_spec,
- .num_event_specs = ARRAY_SIZE(ad2s1210_velocity_event_spec),
- },
- IIO_CHAN_SOFT_TIMESTAMP(2),
- {
- /* used to configure LOT thresholds and get tracking error */
- .type = IIO_ANGL,
- .indexed = 1,
- .channel = 1,
- .scan_index = -1,
- .event_spec = ad2s1210_position_event_spec,
- .num_event_specs = ARRAY_SIZE(ad2s1210_position_event_spec),
- },
- {
- /* used to configure phase lock range and get phase lock error */
- .type = IIO_PHASE,
- .indexed = 1,
- .channel = 0,
- .scan_index = -1,
- .event_spec = ad2s1210_phase_event_spec,
- .num_event_specs = ARRAY_SIZE(ad2s1210_phase_event_spec),
- }, {
- /* excitation frequency output */
- .type = IIO_ALTVOLTAGE,
- .indexed = 1,
- .channel = 0,
- .output = 1,
- .scan_index = -1,
- .info_mask_separate = BIT(IIO_CHAN_INFO_FREQUENCY),
- .info_mask_separate_available = BIT(IIO_CHAN_INFO_FREQUENCY),
- }, {
- /* monitor signal */
- .type = IIO_ALTVOLTAGE,
- .indexed = 1,
- .channel = 0,
- .scan_index = -1,
- .event_spec = ad2s1210_monitor_signal_event_spec,
- .num_event_specs = ARRAY_SIZE(ad2s1210_monitor_signal_event_spec),
- }, {
- /* sine input */
- .type = IIO_ALTVOLTAGE,
- .indexed = 1,
- .channel = 1,
- .scan_index = -1,
- .event_spec = ad2s1210_sin_cos_event_spec,
- .num_event_specs = ARRAY_SIZE(ad2s1210_sin_cos_event_spec),
- }, {
- /* cosine input */
- .type = IIO_ALTVOLTAGE,
- .indexed = 1,
- .channel = 2,
- .scan_index = -1,
- .event_spec = ad2s1210_sin_cos_event_spec,
- .num_event_specs = ARRAY_SIZE(ad2s1210_sin_cos_event_spec),
- },
-};
-
-static ssize_t event_attr_voltage_reg_show(struct device *dev,
- struct device_attribute *attr,
- char *buf)
-{
- struct ad2s1210_state *st = iio_priv(dev_to_iio_dev(dev));
- struct iio_dev_attr *iattr = to_iio_dev_attr(attr);
- unsigned int value;
- int ret;
-
- guard(mutex)(&st->lock);
- ret = regmap_read(st->regmap, iattr->address, &value);
- if (ret < 0)
- return ret;
-
- return sprintf(buf, "%d\n", value * THRESHOLD_MILLIVOLT_PER_LSB);
-}
-
-static ssize_t event_attr_voltage_reg_store(struct device *dev,
- struct device_attribute *attr,
- const char *buf, size_t len)
-{
- struct ad2s1210_state *st = iio_priv(dev_to_iio_dev(dev));
- struct iio_dev_attr *iattr = to_iio_dev_attr(attr);
- u16 data;
- int ret;
-
- ret = kstrtou16(buf, 10, &data);
- if (ret)
- return -EINVAL;
-
- guard(mutex)(&st->lock);
- ret = regmap_write(st->regmap, iattr->address,
- data / THRESHOLD_MILLIVOLT_PER_LSB);
- if (ret < 0)
- return ret;
-
- return len;
-}
-
-static ssize_t
-in_angl1_thresh_rising_value_available_show(struct device *dev,
- struct device_attribute *attr,
- char *buf)
-{
- struct ad2s1210_state *st = iio_priv(dev_to_iio_dev(dev));
- int step = ad2s1210_lot_threshold_urad_per_lsb[st->resolution];
-
- return sysfs_emit(buf, "[0 0.%06d 0.%06d]\n", step, step * 0x7F);
-}
-
-static ssize_t
-in_angl1_thresh_rising_hysteresis_available_show(struct device *dev,
- struct device_attribute *attr,
- char *buf)
-{
- struct ad2s1210_state *st = iio_priv(dev_to_iio_dev(dev));
- int step = ad2s1210_lot_threshold_urad_per_lsb[st->resolution];
-
- return sysfs_emit(buf, "[0 0.%06d 0.%06d]\n", step, step * 0x7F);
-}
-
-static IIO_CONST_ATTR(in_phase0_mag_rising_value_available,
- __stringify(PHASE_44_DEG_TO_RAD_INT) "."
- __stringify(PHASE_44_DEG_TO_RAD_MICRO) " "
- __stringify(PHASE_360_DEG_TO_RAD_INT) "."
- __stringify(PHASE_360_DEG_TO_RAD_MICRO));
-static IIO_CONST_ATTR(in_altvoltage0_thresh_falling_value_available,
- THRESHOLD_RANGE_STR);
-static IIO_CONST_ATTR(in_altvoltage0_thresh_rising_value_available,
- THRESHOLD_RANGE_STR);
-static IIO_CONST_ATTR(in_altvoltage0_mag_rising_value_available,
- THRESHOLD_RANGE_STR);
-static IIO_DEVICE_ATTR(in_altvoltage0_mag_rising_reset_max, 0644,
- event_attr_voltage_reg_show, event_attr_voltage_reg_store,
- AD2S1210_REG_DOS_RST_MAX_THRD);
-static IIO_CONST_ATTR(in_altvoltage0_mag_rising_reset_max_available, THRESHOLD_RANGE_STR);
-static IIO_DEVICE_ATTR(in_altvoltage0_mag_rising_reset_min, 0644,
- event_attr_voltage_reg_show, event_attr_voltage_reg_store,
- AD2S1210_REG_DOS_RST_MIN_THRD);
-static IIO_CONST_ATTR(in_altvoltage0_mag_rising_reset_min_available, THRESHOLD_RANGE_STR);
-static IIO_DEVICE_ATTR_RO(in_angl1_thresh_rising_value_available, 0);
-static IIO_DEVICE_ATTR_RO(in_angl1_thresh_rising_hysteresis_available, 0);
-
-static struct attribute *ad2s1210_event_attributes[] = {
- &iio_const_attr_in_phase0_mag_rising_value_available.dev_attr.attr,
- &iio_const_attr_in_altvoltage0_thresh_falling_value_available.dev_attr.attr,
- &iio_const_attr_in_altvoltage0_thresh_rising_value_available.dev_attr.attr,
- &iio_const_attr_in_altvoltage0_mag_rising_value_available.dev_attr.attr,
- &iio_dev_attr_in_altvoltage0_mag_rising_reset_max.dev_attr.attr,
- &iio_const_attr_in_altvoltage0_mag_rising_reset_max_available.dev_attr.attr,
- &iio_dev_attr_in_altvoltage0_mag_rising_reset_min.dev_attr.attr,
- &iio_const_attr_in_altvoltage0_mag_rising_reset_min_available.dev_attr.attr,
- &iio_dev_attr_in_angl1_thresh_rising_value_available.dev_attr.attr,
- &iio_dev_attr_in_angl1_thresh_rising_hysteresis_available.dev_attr.attr,
- NULL,
-};
-
-static const struct attribute_group ad2s1210_event_attribute_group = {
- .attrs = ad2s1210_event_attributes,
-};
-
-static int ad2s1210_initial(struct ad2s1210_state *st)
-{
- unsigned int data;
- int ret;
-
- guard(mutex)(&st->lock);
-
- /* Use default config register value plus resolution from devicetree. */
- data = FIELD_PREP(AD2S1210_PHASE_LOCK_RANGE_44, 1);
- data |= FIELD_PREP(AD2S1210_ENABLE_HYSTERESIS, 1);
- data |= FIELD_PREP(AD2S1210_SET_ENRES, 0x3);
- data |= FIELD_PREP(AD2S1210_SET_RES, st->resolution);
-
- ret = regmap_write(st->regmap, AD2S1210_REG_CONTROL, data);
- if (ret < 0)
- return ret;
-
- return ad2s1210_reinit_excitation_frequency(st, AD2S1210_DEF_EXCIT);
-}
-
-static int ad2s1210_read_label(struct iio_dev *indio_dev,
- struct iio_chan_spec const *chan,
- char *label)
-{
- if (chan->type == IIO_ANGL) {
- if (chan->channel == 0)
- return sprintf(label, "position\n");
- if (chan->channel == 1)
- return sprintf(label, "tracking error\n");
- }
- if (chan->type == IIO_ANGL_VEL)
- return sprintf(label, "velocity\n");
- if (chan->type == IIO_PHASE)
- return sprintf(label, "synthetic reference\n");
- if (chan->type == IIO_ALTVOLTAGE) {
- if (chan->output)
- return sprintf(label, "excitation\n");
- if (chan->channel == 0)
- return sprintf(label, "monitor signal\n");
- if (chan->channel == 1)
- return sprintf(label, "cosine\n");
- if (chan->channel == 2)
- return sprintf(label, "sine\n");
- }
-
- return -EINVAL;
-}
-
-static int ad2s1210_read_event_value(struct iio_dev *indio_dev,
- const struct iio_chan_spec *chan,
- enum iio_event_type type,
- enum iio_event_direction dir,
- enum iio_event_info info,
- int *val, int *val2)
-{
- struct ad2s1210_state *st = iio_priv(indio_dev);
-
- switch (chan->type) {
- case IIO_ANGL:
- switch (info) {
- case IIO_EV_INFO_VALUE:
- return ad2s1210_get_lot_high_threshold(st, val, val2);
- case IIO_EV_INFO_HYSTERESIS:
- return ad2s1210_get_lot_low_threshold(st, val, val2);
- default:
- return -EINVAL;
- }
- case IIO_ALTVOLTAGE:
- if (chan->output)
- return -EINVAL;
- if (type == IIO_EV_TYPE_THRESH && dir == IIO_EV_DIR_FALLING)
- return ad2s1210_get_voltage_threshold(st,
- AD2S1210_REG_LOS_THRD, val);
- if (type == IIO_EV_TYPE_THRESH && dir == IIO_EV_DIR_RISING)
- return ad2s1210_get_voltage_threshold(st,
- AD2S1210_REG_DOS_OVR_THRD, val);
- if (type == IIO_EV_TYPE_MAG)
- return ad2s1210_get_voltage_threshold(st,
- AD2S1210_REG_DOS_MIS_THRD, val);
- return -EINVAL;
- case IIO_PHASE:
- return ad2s1210_get_phase_lock_range(st, val, val2);
- default:
- return -EINVAL;
- }
-}
-
-static int ad2s1210_write_event_value(struct iio_dev *indio_dev,
- const struct iio_chan_spec *chan,
- enum iio_event_type type,
- enum iio_event_direction dir,
- enum iio_event_info info,
- int val, int val2)
-{
- struct ad2s1210_state *st = iio_priv(indio_dev);
-
- switch (chan->type) {
- case IIO_ANGL:
- switch (info) {
- case IIO_EV_INFO_VALUE:
- return ad2s1210_set_lot_high_threshold(st, val, val2);
- case IIO_EV_INFO_HYSTERESIS:
- return ad2s1210_set_lot_low_threshold(st, val, val2);
- default:
- return -EINVAL;
- }
- case IIO_ALTVOLTAGE:
- if (chan->output)
- return -EINVAL;
- if (type == IIO_EV_TYPE_THRESH && dir == IIO_EV_DIR_FALLING)
- return ad2s1210_set_voltage_threshold(st,
- AD2S1210_REG_LOS_THRD, val);
- if (type == IIO_EV_TYPE_THRESH && dir == IIO_EV_DIR_RISING)
- return ad2s1210_set_voltage_threshold(st,
- AD2S1210_REG_DOS_OVR_THRD, val);
- if (type == IIO_EV_TYPE_MAG)
- return ad2s1210_set_voltage_threshold(st,
- AD2S1210_REG_DOS_MIS_THRD, val);
- return -EINVAL;
- case IIO_PHASE:
- return ad2s1210_set_phase_lock_range(st, val, val2);
- default:
- return -EINVAL;
- }
-}
-
-static int ad2s1210_read_event_label(struct iio_dev *indio_dev,
- struct iio_chan_spec const *chan,
- enum iio_event_type type,
- enum iio_event_direction dir,
- char *label)
-{
- if (chan->type == IIO_ANGL)
- return sprintf(label, "LOT\n");
- if (chan->type == IIO_ANGL_VEL)
- return sprintf(label, "max tracking rate\n");
- if (chan->type == IIO_PHASE)
- return sprintf(label, "phase lock\n");
- if (chan->type == IIO_ALTVOLTAGE) {
- if (chan->channel == 0) {
- if (type == IIO_EV_TYPE_THRESH &&
- dir == IIO_EV_DIR_FALLING)
- return sprintf(label, "LOS\n");
- if (type == IIO_EV_TYPE_THRESH &&
- dir == IIO_EV_DIR_RISING)
- return sprintf(label, "DOS overrange\n");
- if (type == IIO_EV_TYPE_MAG)
- return sprintf(label, "DOS mismatch\n");
- }
- if (chan->channel == 1 || chan->channel == 2)
- return sprintf(label, "clipped\n");
- }
-
- return -EINVAL;
-}
-
-static int ad2s1210_debugfs_reg_access(struct iio_dev *indio_dev,
- unsigned int reg, unsigned int writeval,
- unsigned int *readval)
-{
- struct ad2s1210_state *st = iio_priv(indio_dev);
-
- guard(mutex)(&st->lock);
-
- if (readval)
- return regmap_read(st->regmap, reg, readval);
-
- return regmap_write(st->regmap, reg, writeval);
-}
-
-static irqreturn_t ad2s1210_trigger_handler(int irq, void *p)
-{
- struct iio_poll_func *pf = p;
- struct iio_dev *indio_dev = pf->indio_dev;
- struct ad2s1210_state *st = iio_priv(indio_dev);
- size_t chan = 0;
- int ret;
-
- guard(mutex)(&st->lock);
-
- memset(&st->scan, 0, sizeof(st->scan));
- ad2s1210_toggle_sample_line(st);
-
- if (test_bit(0, indio_dev->active_scan_mask)) {
- ret = ad2s1210_set_mode(st, MOD_POS);
- if (ret < 0)
- goto error_ret;
-
- ret = spi_read(st->sdev, &st->sample, 3);
- if (ret < 0)
- goto error_ret;
-
- memcpy(&st->scan.chan[chan++], &st->sample.raw, 2);
- }
-
- if (test_bit(1, indio_dev->active_scan_mask)) {
- ret = ad2s1210_set_mode(st, MOD_VEL);
- if (ret < 0)
- goto error_ret;
-
- ret = spi_read(st->sdev, &st->sample, 3);
- if (ret < 0)
- goto error_ret;
-
- memcpy(&st->scan.chan[chan++], &st->sample.raw, 2);
- }
-
- ad2s1210_push_events(indio_dev, st->sample.fault, pf->timestamp);
- iio_push_to_buffers_with_timestamp(indio_dev, &st->scan, pf->timestamp);
-
-error_ret:
- iio_trigger_notify_done(indio_dev->trig);
-
- return IRQ_HANDLED;
-}
-
-static const struct iio_info ad2s1210_info = {
- .event_attrs = &ad2s1210_event_attribute_group,
- .read_raw = ad2s1210_read_raw,
- .read_avail = ad2s1210_read_avail,
- .write_raw = ad2s1210_write_raw,
- .read_label = ad2s1210_read_label,
- .read_event_value = ad2s1210_read_event_value,
- .write_event_value = ad2s1210_write_event_value,
- .read_event_label = ad2s1210_read_event_label,
- .debugfs_reg_access = &ad2s1210_debugfs_reg_access,
-};
-
-static int ad2s1210_setup_properties(struct ad2s1210_state *st)
-{
- struct device *dev = &st->sdev->dev;
- u32 val;
- int ret;
-
- ret = device_property_read_u32(dev, "assigned-resolution-bits", &val);
- if (ret < 0)
- return dev_err_probe(dev, ret,
- "failed to read assigned-resolution-bits property\n");
-
- if (val < 10 || val > 16)
- return dev_err_probe(dev, -EINVAL,
- "resolution out of range: %u\n", val);
-
- st->resolution = (val - 10) >> 1;
- /*
- * These are values that correlate to the hysteresis bit in the Control
- * register. 0 = disabled, 1 = enabled. When enabled, the actual
- * hysteresis is +/- 1 LSB of the raw position value. Which bit is the
- * LSB depends on the specified resolution.
- */
- st->hysteresis_available[0] = 0;
- st->hysteresis_available[1] = 1 << (2 * (AD2S1210_RES_16 -
- st->resolution));
-
- return 0;
-}
-
-static int ad2s1210_setup_clocks(struct ad2s1210_state *st)
-{
- struct device *dev = &st->sdev->dev;
- struct clk *clk;
-
- clk = devm_clk_get_enabled(dev, NULL);
- if (IS_ERR(clk))
- return dev_err_probe(dev, PTR_ERR(clk), "failed to get clock\n");
-
- st->clkin_hz = clk_get_rate(clk);
- if (st->clkin_hz < AD2S1210_MIN_CLKIN || st->clkin_hz > AD2S1210_MAX_CLKIN)
- return dev_err_probe(dev, -EINVAL,
- "clock frequency out of range: %lu\n",
- st->clkin_hz);
-
- return 0;
-}
-
-static int ad2s1210_setup_gpios(struct ad2s1210_state *st)
-{
- struct device *dev = &st->sdev->dev;
- struct gpio_descs *resolution_gpios;
- DECLARE_BITMAP(bitmap, 2);
- int ret;
-
- /* should not be sampling on startup */
- st->sample_gpio = devm_gpiod_get(dev, "sample", GPIOD_OUT_LOW);
- if (IS_ERR(st->sample_gpio))
- return dev_err_probe(dev, PTR_ERR(st->sample_gpio),
- "failed to request sample GPIO\n");
-
- /* both pins high means that we start in config mode */
- st->mode_gpios = devm_gpiod_get_array(dev, "mode", GPIOD_OUT_HIGH);
- if (IS_ERR(st->mode_gpios))
- return dev_err_probe(dev, PTR_ERR(st->mode_gpios),
- "failed to request mode GPIOs\n");
-
- if (st->mode_gpios->ndescs != 2)
- return dev_err_probe(dev, -EINVAL,
- "requires exactly 2 mode-gpios\n");
-
- /*
- * If resolution gpios are provided, they get set to the required
- * resolution, otherwise it is assumed the RES0 and RES1 pins are
- * hard-wired to match the resolution indicated in the devicetree.
- */
- resolution_gpios = devm_gpiod_get_array_optional(dev, "resolution",
- GPIOD_ASIS);
- if (IS_ERR(resolution_gpios))
- return dev_err_probe(dev, PTR_ERR(resolution_gpios),
- "failed to request resolution GPIOs\n");
-
- if (resolution_gpios) {
- if (resolution_gpios->ndescs != 2)
- return dev_err_probe(dev, -EINVAL,
- "requires exactly 2 resolution-gpios\n");
-
- bitmap[0] = st->resolution;
-
- ret = gpiod_set_array_value(resolution_gpios->ndescs,
- resolution_gpios->desc,
- resolution_gpios->info,
- bitmap);
- if (ret < 0)
- return dev_err_probe(dev, ret,
- "failed to set resolution gpios\n");
- }
-
- return 0;
-}
-
-static const struct regmap_range ad2s1210_regmap_readable_ranges[] = {
- regmap_reg_range(AD2S1210_REG_POSITION_MSB, AD2S1210_REG_VELOCITY_LSB),
- regmap_reg_range(AD2S1210_REG_LOS_THRD, AD2S1210_REG_LOT_LOW_THRD),
- regmap_reg_range(AD2S1210_REG_EXCIT_FREQ, AD2S1210_REG_CONTROL),
- regmap_reg_range(AD2S1210_REG_FAULT, AD2S1210_REG_FAULT),
-};
-
-static const struct regmap_access_table ad2s1210_regmap_rd_table = {
- .yes_ranges = ad2s1210_regmap_readable_ranges,
- .n_yes_ranges = ARRAY_SIZE(ad2s1210_regmap_readable_ranges),
-};
-
-static const struct regmap_range ad2s1210_regmap_writeable_ranges[] = {
- regmap_reg_range(AD2S1210_REG_LOS_THRD, AD2S1210_REG_LOT_LOW_THRD),
- regmap_reg_range(AD2S1210_REG_EXCIT_FREQ, AD2S1210_REG_CONTROL),
- regmap_reg_range(AD2S1210_REG_SOFT_RESET, AD2S1210_REG_SOFT_RESET),
- regmap_reg_range(AD2S1210_REG_FAULT, AD2S1210_REG_FAULT),
-};
-
-static const struct regmap_access_table ad2s1210_regmap_wr_table = {
- .yes_ranges = ad2s1210_regmap_writeable_ranges,
- .n_yes_ranges = ARRAY_SIZE(ad2s1210_regmap_writeable_ranges),
-};
-
-static int ad2s1210_setup_regmap(struct ad2s1210_state *st)
-{
- struct device *dev = &st->sdev->dev;
- const struct regmap_config config = {
- .reg_bits = 8,
- .val_bits = 8,
- .disable_locking = true,
- .reg_read = ad2s1210_regmap_reg_read,
- .reg_write = ad2s1210_regmap_reg_write,
- .rd_table = &ad2s1210_regmap_rd_table,
- .wr_table = &ad2s1210_regmap_wr_table,
- .can_sleep = true,
- };
-
- st->regmap = devm_regmap_init(dev, NULL, st, &config);
- if (IS_ERR(st->regmap))
- return dev_err_probe(dev, PTR_ERR(st->regmap),
- "failed to allocate register map\n");
-
- return 0;
-}
-
-static int ad2s1210_probe(struct spi_device *spi)
-{
- struct iio_dev *indio_dev;
- struct ad2s1210_state *st;
- int ret;
-
- indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*st));
- if (!indio_dev)
- return -ENOMEM;
- st = iio_priv(indio_dev);
-
- mutex_init(&st->lock);
- st->sdev = spi;
-
- ret = ad2s1210_setup_properties(st);
- if (ret < 0)
- return ret;
-
- ret = ad2s1210_setup_clocks(st);
- if (ret < 0)
- return ret;
-
- ret = ad2s1210_setup_gpios(st);
- if (ret < 0)
- return ret;
-
- ret = ad2s1210_setup_regmap(st);
- if (ret < 0)
- return ret;
-
- ret = ad2s1210_initial(st);
- if (ret < 0)
- return ret;
-
- indio_dev->info = &ad2s1210_info;
- indio_dev->modes = INDIO_DIRECT_MODE;
- indio_dev->channels = ad2s1210_channels;
- indio_dev->num_channels = ARRAY_SIZE(ad2s1210_channels);
- indio_dev->name = spi_get_device_id(spi)->name;
-
- ret = devm_iio_triggered_buffer_setup(&spi->dev, indio_dev,
- &iio_pollfunc_store_time,
- &ad2s1210_trigger_handler, NULL);
- if (ret < 0)
- return dev_err_probe(&spi->dev, ret,
- "iio triggered buffer setup failed\n");
-
- return devm_iio_device_register(&spi->dev, indio_dev);
-}
-
-static const struct of_device_id ad2s1210_of_match[] = {
- { .compatible = "adi,ad2s1210", },
- { }
-};
-MODULE_DEVICE_TABLE(of, ad2s1210_of_match);
-
-static const struct spi_device_id ad2s1210_id[] = {
- { "ad2s1210" },
- {}
-};
-MODULE_DEVICE_TABLE(spi, ad2s1210_id);
-
-static struct spi_driver ad2s1210_driver = {
- .driver = {
- .name = DRV_NAME,
- .of_match_table = of_match_ptr(ad2s1210_of_match),
- },
- .probe = ad2s1210_probe,
- .id_table = ad2s1210_id,
-};
-module_spi_driver(ad2s1210_driver);
-
-MODULE_AUTHOR("Graff Yang <[email protected]>");
-MODULE_DESCRIPTION("Analog Devices AD2S1210 Resolver to Digital SPI driver");
-MODULE_LICENSE("GPL v2");
--
2.42.0
On Tue, 10 Oct 2023 16:12:33 -0500
David Lechner <[email protected]> wrote:
> This refactors the sample line toggle in the ad2s1210 resolver driver
> to a separate function. The sample has some timing requirements, so
> this ensures that it is always done the same way, both in the existing
> call sites and any future usage.
>
> Previously, the sample line was kept on for the duration of the read,
> but this is not necessary. Data is latched in on the rising edge and
> after the specified delay the state of the sample line does not matter.
>
> Signed-off-by: David Lechner <[email protected]>
Applied.
On Tue, 10 Oct 2023 16:12:34 -0500
David Lechner <[email protected]> wrote:
> When a software reset is performed on the AD2S1210 to make the selected
> excitation frequency take effect, it always triggers faults on the
> input signals because the output signal is interrupted momentarily.
> So we need to clear the faults after the software reset to avoid
> triggering fault events the next time a sample is read.
>
> The datasheet specifies a time t[track] in Table 27 that specifies the
> settle time in milliseconds after a reset depending on the selected
> resolution. This is used in the driver to add an appropriate delay.
>
> Signed-off-by: David Lechner <[email protected]>
Applied
On Tue, 10 Oct 2023 16:12:35 -0500
David Lechner <[email protected]> wrote:
> We can simplify the code and get rid of most of the gotos by using
> guard(mutex) from cleanup.h.
>
> Signed-off-by: David Lechner <[email protected]>
Applied.
On Tue, 10 Oct 2023 16:12:36 -0500
David Lechner <[email protected]> wrote:
> This moves the ad2s1210 resolver driver out of staging. The driver has
> been fixed up and is ready to graduate.
>
> Signed-off-by: David Lechner <[email protected]>
> ---
>
> v5 changes: New patch in v5.
>
> Diff was made with file rename detection turned off so we can see the full
> driver code for one last check through. sysfs-bus-iio-resolver-ad2s1210 and
> ad2s1210.c are just moved (no changes).
Excellent. Great work btw - this looks really nice now.
I did a final scan through (most of the code was familiar for some reason :)
I've called out a few things that I'd like to see tidied up in follow up patches
but definitely nothing that prevents us making the move out of staging.
If you are happy to do a patch dropping of_match_ptr() then great, if not I'll
send one out at somepoint soon. I didn't want to just sneak it in here as an
edit whilst applying because I like the clean copy of identical code in these
move patches.
If anyone else wants to review, unless they see anything critical / ABI changing
I'd like any follow on work that comes up to be done as patches on a normal / non
staging driver.
Removing another directory in staging/iio is great as well :)
Applied to the togreg branch of iio.git, but pushed out initially as testing to
let 0-day take a quick look.
Thanks
Jonathan
>
> .../testing/sysfs-bus-iio-resolver-ad2s1210 | 27 +
> drivers/iio/resolver/Kconfig | 13 +
> drivers/iio/resolver/Makefile | 1 +
> drivers/iio/resolver/ad2s1210.c | 1522 +++++++++++++++++
> .../sysfs-bus-iio-resolver-ad2s1210 | 27 -
> drivers/staging/iio/Kconfig | 1 -
> drivers/staging/iio/Makefile | 1 -
> drivers/staging/iio/resolver/Kconfig | 19 -
> drivers/staging/iio/resolver/Makefile | 6 -
> drivers/staging/iio/resolver/ad2s1210.c | 1522 -----------------
> 10 files changed, 1563 insertions(+), 1576 deletions(-)
> create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-resolver-ad2s1210
> create mode 100644 drivers/iio/resolver/ad2s1210.c
> delete mode 100644 drivers/staging/iio/Documentation/sysfs-bus-iio-resolver-ad2s1210
> delete mode 100644 drivers/staging/iio/resolver/Kconfig
> delete mode 100644 drivers/staging/iio/resolver/Makefile
> delete mode 100644 drivers/staging/iio/resolver/ad2s1210.c
>
> diff --git a/drivers/iio/resolver/ad2s1210.c b/drivers/iio/resolver/ad2s1210.c
> new file mode 100644
> index 000000000000..bd4a90c222b5
> --- /dev/null
> +++ b/drivers/iio/resolver/ad2s1210.c
> @@ -0,0 +1,1522 @@
> +
> +#define DRV_NAME "ad2s1210"
> +
Nice to tidy up:
This is a pet hate of mine. Why have a define for DRV_NAME that is only
used in one or two places? That's where we will go to find out what it is
called, so define just makes that take one more step!
> +/*
> + * Toggles the SAMPLE line on the AD2S1210 to latch in the current position,
> + * velocity, and faults.
> + *
> + * Must be called with lock held.
> + */
> +static void ad2s1210_toggle_sample_line(struct ad2s1210_state *st)
> +{
> + /*
> + * Datasheet specifies minimum hold time t16 = 2 * tck + 20 ns. So the
> + * longest time needed is when CLKIN is 6.144 MHz, in which case t16
> + * ~= 350 ns. The same delay is also needed before re-asserting the
Potential issue in long term but wait and see:
Hmm. The about equal makes me a little nervous long term. Far too much history of
parts being produced that don't quite meet the documented timing. Still can fix
it if we see any problems.
> + * SAMPLE line.
> + */
> + gpiod_set_value(st->sample_gpio, 1);
> + ndelay(350);
> + gpiod_set_value(st->sample_gpio, 0);
> + ndelay(350);
> +}
> +
> +static struct spi_driver ad2s1210_driver = {
> + .driver = {
> + .name = DRV_NAME,
> + .of_match_table = of_match_ptr(ad2s1210_of_match),
Fix this in a follow up patch:
Don't guard a of_match_table with of_match_ptr(). All that does is prevent
any chance of using another firmware (ACPI PRP0001 for example) that
uses this table to match.
> + },
> + .probe = ad2s1210_probe,
> + .id_table = ad2s1210_id,
> +};
> +module_spi_driver(ad2s1210_driver);
On Thu, Oct 12, 2023 at 3:25 AM Jonathan Cameron <[email protected]> wrote:
>
> On Tue, 10 Oct 2023 16:12:36 -0500
> David Lechner <[email protected]> wrote:
>
> > This moves the ad2s1210 resolver driver out of staging. The driver has
> > been fixed up and is ready to graduate.
> >
> > Signed-off-by: David Lechner <[email protected]>
> > ---
> >
> > v5 changes: New patch in v5.
> >
> > Diff was made with file rename detection turned off so we can see the full
> > driver code for one last check through. sysfs-bus-iio-resolver-ad2s1210 and
> > ad2s1210.c are just moved (no changes).
>
> Excellent. Great work btw - this looks really nice now.
>
> I did a final scan through (most of the code was familiar for some reason :)
Thanks for all of the reviews. There were less than 200 lines left
(mostly blank lines and boilerplate) that didn't get touched!