Linux-IIO Archive on lore.kernel.org
 help / color / Atom feed
* [PATCH v5 0/6] Support ADIS16475 and similar IMUs
@ 2020-04-13  8:24 Nuno Sá
  2020-04-13  8:24 ` [PATCH v5 1/6] iio: imu: adis: Add Managed device functions Nuno Sá
                   ` (6 more replies)
  0 siblings, 7 replies; 24+ messages in thread
From: Nuno Sá @ 2020-04-13  8:24 UTC (permalink / raw)
  To: linux-iio, devicetree
  Cc: Jonathan Cameron, Hartmut Knaack, Lars-Peter Clausen,
	Peter Meerwald-Stadler, Rob Herring, Mark Rutland,
	Alexandru Ardelean, Michael Hennerich

This series adds support for the adis16475 and similar IMUs. This driver
will be the first user of some changes on the adis library. Hence, the
first three patches are related to the library:
 * Add anaged device functions for registering triggers with the library;
 * Updates the way `irq_mask` is passed to `request_irq()`;
 * It adds an update_bits() like API.

A new patch was introduced (iio: adis: Add burst_max_len variable) in
order to make burst32 configuration at runtime.

Nuno Sá (6):
  iio: imu: adis: Add Managed device functions
  iio: imu: adis: Add irq mask variable
  iio: adis: Add adis_update_bits() APIs
  iio: adis: Support different burst sizes
  iio: imu: Add support for adis16475
  dt-bindings: iio: Add adis16475 documentation

 .../bindings/iio/imu/adi,adis16475.yaml       |  137 ++
 MAINTAINERS                                   |    8 +
 drivers/iio/imu/Kconfig                       |   13 +
 drivers/iio/imu/Makefile                      |    1 +
 drivers/iio/imu/adis.c                        |   25 +
 drivers/iio/imu/adis16400.c                   |    2 +-
 drivers/iio/imu/adis16475.c                   | 1336 +++++++++++++++++
 drivers/iio/imu/adis_buffer.c                 |   58 +-
 drivers/iio/imu/adis_trigger.c                |   72 +-
 include/linux/iio/imu/adis.h                  |   87 +-
 10 files changed, 1728 insertions(+), 11 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/iio/imu/adi,adis16475.yaml
 create mode 100644 drivers/iio/imu/adis16475.c

-- 
2.17.1


^ permalink raw reply	[flat|nested] 24+ messages in thread

* [PATCH v5 1/6] iio: imu: adis: Add Managed device functions
  2020-04-13  8:24 [PATCH v5 0/6] Support ADIS16475 and similar IMUs Nuno Sá
@ 2020-04-13  8:24 ` Nuno Sá
  2020-04-13  8:24 ` [PATCH v5 2/6] iio: imu: adis: Add irq flag variable Nuno Sá
                   ` (5 subsequent siblings)
  6 siblings, 0 replies; 24+ messages in thread
From: Nuno Sá @ 2020-04-13  8:24 UTC (permalink / raw)
  To: linux-iio, devicetree
  Cc: Jonathan Cameron, Hartmut Knaack, Lars-Peter Clausen,
	Peter Meerwald-Stadler, Rob Herring, Mark Rutland,
	Alexandru Ardelean, Michael Hennerich

This patch adds support for a managed device version of
adis_setup_buffer_and_trigger. It works exactly as the original
one but it calls all the devm_iio_* functions to setup an iio
buffer and trigger. Hence we do not need to care about cleaning those
and we do not need to support a remove() callback for every driver using
the adis library.

Signed-off-by: Nuno Sá <nuno.sa@analog.com>
---
Changes in v2:
 * Added blank lines for readability.

Changes in V3:
 * Removed unnecessary inline;
 * Free buffer resources.

Changes in v4:
 * Make use of irq_handler_t.

Changes in v5:
 * Nothing changed.

 drivers/iio/imu/adis_buffer.c  | 45 ++++++++++++++++++++++++++++++++++
 drivers/iio/imu/adis_trigger.c | 41 ++++++++++++++++++++++++++++---
 include/linux/iio/imu/adis.h   | 17 +++++++++++++
 3 files changed, 100 insertions(+), 3 deletions(-)

diff --git a/drivers/iio/imu/adis_buffer.c b/drivers/iio/imu/adis_buffer.c
index 04e5e2a0fd6b..8fdc4dca10c0 100644
--- a/drivers/iio/imu/adis_buffer.c
+++ b/drivers/iio/imu/adis_buffer.c
@@ -156,6 +156,14 @@ static irqreturn_t adis_trigger_handler(int irq, void *p)
 	return IRQ_HANDLED;
 }
 
+static void adis_buffer_cleanup(void *arg)
+{
+	struct adis *adis = arg;
+
+	kfree(adis->buffer);
+	kfree(adis->xfer);
+}
+
 /**
  * adis_setup_buffer_and_trigger() - Sets up buffer and trigger for the adis device
  * @adis: The adis device.
@@ -198,6 +206,43 @@ int adis_setup_buffer_and_trigger(struct adis *adis, struct iio_dev *indio_dev,
 }
 EXPORT_SYMBOL_GPL(adis_setup_buffer_and_trigger);
 
+/**
+ * devm_adis_setup_buffer_and_trigger() - Sets up buffer and trigger for
+ *					  the managed adis device
+ * @adis: The adis device
+ * @indio_dev: The IIO device
+ * @trigger_handler: Optional trigger handler, may be NULL.
+ *
+ * Returns 0 on success, a negative error code otherwise.
+ *
+ * This function perfoms exactly the same as adis_setup_buffer_and_trigger()
+ */
+int
+devm_adis_setup_buffer_and_trigger(struct adis *adis, struct iio_dev *indio_dev,
+				   irq_handler_t trigger_handler)
+{
+	int ret;
+
+	if (!trigger_handler)
+		trigger_handler = adis_trigger_handler;
+
+	ret = devm_iio_triggered_buffer_setup(&adis->spi->dev, indio_dev,
+					      &iio_pollfunc_store_time,
+					      trigger_handler, NULL);
+	if (ret)
+		return ret;
+
+	if (adis->spi->irq) {
+		ret = devm_adis_probe_trigger(adis, indio_dev);
+		if (ret)
+			return ret;
+	}
+
+	return devm_add_action_or_reset(&adis->spi->dev, adis_buffer_cleanup,
+					adis);
+}
+EXPORT_SYMBOL_GPL(devm_adis_setup_buffer_and_trigger);
+
 /**
  * adis_cleanup_buffer_and_trigger() - Free buffer and trigger resources
  * @adis: The adis device.
diff --git a/drivers/iio/imu/adis_trigger.c b/drivers/iio/imu/adis_trigger.c
index 8b9cd02c0f9f..a36810e0b1ab 100644
--- a/drivers/iio/imu/adis_trigger.c
+++ b/drivers/iio/imu/adis_trigger.c
@@ -27,6 +27,13 @@ static const struct iio_trigger_ops adis_trigger_ops = {
 	.set_trigger_state = &adis_data_rdy_trigger_set_state,
 };
 
+static void adis_trigger_setup(struct adis *adis)
+{
+	adis->trig->dev.parent = &adis->spi->dev;
+	adis->trig->ops = &adis_trigger_ops;
+	iio_trigger_set_drvdata(adis->trig, adis);
+}
+
 /**
  * adis_probe_trigger() - Sets up trigger for a adis device
  * @adis: The adis device
@@ -45,9 +52,7 @@ int adis_probe_trigger(struct adis *adis, struct iio_dev *indio_dev)
 	if (adis->trig == NULL)
 		return -ENOMEM;
 
-	adis->trig->dev.parent = &adis->spi->dev;
-	adis->trig->ops = &adis_trigger_ops;
-	iio_trigger_set_drvdata(adis->trig, adis);
+	adis_trigger_setup(adis);
 
 	ret = request_irq(adis->spi->irq,
 			  &iio_trigger_generic_data_rdy_poll,
@@ -73,6 +78,36 @@ int adis_probe_trigger(struct adis *adis, struct iio_dev *indio_dev)
 }
 EXPORT_SYMBOL_GPL(adis_probe_trigger);
 
+/**
+ * devm_adis_probe_trigger() - Sets up trigger for a managed adis device
+ * @adis: The adis device
+ * @indio_dev: The IIO device
+ *
+ * Returns 0 on success or a negative error code
+ */
+int devm_adis_probe_trigger(struct adis *adis, struct iio_dev *indio_dev)
+{
+	int ret;
+
+	adis->trig = devm_iio_trigger_alloc(&adis->spi->dev, "%s-dev%d",
+					    indio_dev->name, indio_dev->id);
+	if (!adis->trig)
+		return -ENOMEM;
+
+	adis_trigger_setup(adis);
+
+	ret = devm_request_irq(&adis->spi->dev, adis->spi->irq,
+			       &iio_trigger_generic_data_rdy_poll,
+			       IRQF_TRIGGER_RISING,
+			       indio_dev->name,
+			       adis->trig);
+	if (ret)
+		return ret;
+
+	return devm_iio_trigger_register(&adis->spi->dev, adis->trig);
+}
+EXPORT_SYMBOL_GPL(devm_adis_probe_trigger);
+
 /**
  * adis_remove_trigger() - Remove trigger for a adis devices
  * @adis: The adis device
diff --git a/include/linux/iio/imu/adis.h b/include/linux/iio/imu/adis.h
index dd8219138c2e..e70814d96e1c 100644
--- a/include/linux/iio/imu/adis.h
+++ b/include/linux/iio/imu/adis.h
@@ -448,11 +448,15 @@ struct adis_burst {
 	unsigned int	extra_len;
 };
 
+int
+devm_adis_setup_buffer_and_trigger(struct adis *adis, struct iio_dev *indio_dev,
+				   irq_handler_t trigger_handler);
 int adis_setup_buffer_and_trigger(struct adis *adis,
 	struct iio_dev *indio_dev, irqreturn_t (*trigger_handler)(int, void *));
 void adis_cleanup_buffer_and_trigger(struct adis *adis,
 	struct iio_dev *indio_dev);
 
+int devm_adis_probe_trigger(struct adis *adis, struct iio_dev *indio_dev);
 int adis_probe_trigger(struct adis *adis, struct iio_dev *indio_dev);
 void adis_remove_trigger(struct adis *adis);
 
@@ -461,6 +465,13 @@ int adis_update_scan_mode(struct iio_dev *indio_dev,
 
 #else /* CONFIG_IIO_BUFFER */
 
+static inline int
+devm_adis_setup_buffer_and_trigger(struct adis *adis, struct iio_dev *indio_dev,
+				   irq_handler_t trigger_handler)
+{
+	return 0;
+}
+
 static inline int adis_setup_buffer_and_trigger(struct adis *adis,
 	struct iio_dev *indio_dev, irqreturn_t (*trigger_handler)(int, void *))
 {
@@ -472,6 +483,12 @@ static inline void adis_cleanup_buffer_and_trigger(struct adis *adis,
 {
 }
 
+static inline int devm_adis_probe_trigger(struct adis *adis,
+					  struct iio_dev *indio_dev)
+{
+	return 0;
+}
+
 static inline int adis_probe_trigger(struct adis *adis,
 	struct iio_dev *indio_dev)
 {
-- 
2.17.1


^ permalink raw reply	[flat|nested] 24+ messages in thread

* [PATCH v5 2/6] iio: imu: adis: Add irq flag variable
  2020-04-13  8:24 [PATCH v5 0/6] Support ADIS16475 and similar IMUs Nuno Sá
  2020-04-13  8:24 ` [PATCH v5 1/6] iio: imu: adis: Add Managed device functions Nuno Sá
@ 2020-04-13  8:24 ` Nuno Sá
  2020-04-13  8:24 ` [PATCH v5 3/6] iio: adis: Add adis_update_bits() APIs Nuno Sá
                   ` (4 subsequent siblings)
  6 siblings, 0 replies; 24+ messages in thread
From: Nuno Sá @ 2020-04-13  8:24 UTC (permalink / raw)
  To: linux-iio, devicetree
  Cc: Jonathan Cameron, Hartmut Knaack, Lars-Peter Clausen,
	Peter Meerwald-Stadler, Rob Herring, Mark Rutland,
	Alexandru Ardelean, Michael Hennerich

There are some ADIS devices that can configure the data ready pin
polarity. Hence, we cannot hardcode our IRQ mask as IRQF_TRIGGER_RISING
since we might want to have it as IRQF_TRIGGER_FALLING.

Signed-off-by: Nuno Sá <nuno.sa@analog.com>
---
Changes in v2:
 * Add kernel doc-string for `irq-mask`.

Changes in v3:
 * Removed unnecessary inline;
 * Renamed `__adis_validate_irq_mask` to `adis_validate_irq_mask` to keep lib consistency;
 * Cosmetics in logs.

Changes in v4:
 * Use flag suffix instead of mask;
 * Add comments to `adis_validate_irq_flag`.

Changes in v5:
 * Change commit subject to irq flag instead of mask.

 drivers/iio/imu/adis_trigger.c | 33 +++++++++++++++++++++++++++++++--
 include/linux/iio/imu/adis.h   |  2 ++
 2 files changed, 33 insertions(+), 2 deletions(-)

diff --git a/drivers/iio/imu/adis_trigger.c b/drivers/iio/imu/adis_trigger.c
index a36810e0b1ab..8afe71947c00 100644
--- a/drivers/iio/imu/adis_trigger.c
+++ b/drivers/iio/imu/adis_trigger.c
@@ -34,6 +34,27 @@ static void adis_trigger_setup(struct adis *adis)
 	iio_trigger_set_drvdata(adis->trig, adis);
 }
 
+static int adis_validate_irq_flag(struct adis *adis)
+{
+	/*
+	 * Typically this devices have data ready either on the rising edge or
+	 * on the falling edge of the data ready pin. This checks enforces that
+	 * one of those is set in the drivers... It defaults to
+	 * IRQF_TRIGGER_RISING for backward compatibility wiht devices that
+	 * don't support changing the pin polarity.
+	 */
+	if (!adis->irq_flag) {
+		adis->irq_flag = IRQF_TRIGGER_RISING;
+		return 0;
+	} else if (adis->irq_flag != IRQF_TRIGGER_RISING &&
+		   adis->irq_flag != IRQF_TRIGGER_FALLING) {
+		dev_err(&adis->spi->dev, "Invalid IRQ mask: %08lx\n",
+			adis->irq_flag);
+		return -EINVAL;
+	}
+
+	return 0;
+}
 /**
  * adis_probe_trigger() - Sets up trigger for a adis device
  * @adis: The adis device
@@ -54,9 +75,13 @@ int adis_probe_trigger(struct adis *adis, struct iio_dev *indio_dev)
 
 	adis_trigger_setup(adis);
 
+	ret = adis_validate_irq_flag(adis);
+	if (ret)
+		return ret;
+
 	ret = request_irq(adis->spi->irq,
 			  &iio_trigger_generic_data_rdy_poll,
-			  IRQF_TRIGGER_RISING,
+			  adis->irq_flag,
 			  indio_dev->name,
 			  adis->trig);
 	if (ret)
@@ -96,9 +121,13 @@ int devm_adis_probe_trigger(struct adis *adis, struct iio_dev *indio_dev)
 
 	adis_trigger_setup(adis);
 
+	ret = adis_validate_irq_flag(adis);
+	if (ret)
+		return ret;
+
 	ret = devm_request_irq(&adis->spi->dev, adis->spi->irq,
 			       &iio_trigger_generic_data_rdy_poll,
-			       IRQF_TRIGGER_RISING,
+			       adis->irq_flag,
 			       indio_dev->name,
 			       adis->trig);
 	if (ret)
diff --git a/include/linux/iio/imu/adis.h b/include/linux/iio/imu/adis.h
index e70814d96e1c..70e4d1d262f5 100644
--- a/include/linux/iio/imu/adis.h
+++ b/include/linux/iio/imu/adis.h
@@ -87,6 +87,7 @@ struct adis_data {
  * @msg: SPI message object
  * @xfer: SPI transfer objects to be used for a @msg
  * @current_page: Some ADIS devices have registers, this selects current page
+ * @irq_flag: IRQ handling flags as passed to request_irq()
  * @buffer: Data buffer for information read from the device
  * @tx: DMA safe TX buffer for SPI transfers
  * @rx: DMA safe RX buffer for SPI transfers
@@ -113,6 +114,7 @@ struct adis {
 	struct spi_message	msg;
 	struct spi_transfer	*xfer;
 	unsigned int		current_page;
+	unsigned long		irq_flag;
 	void			*buffer;
 
 	uint8_t			tx[10] ____cacheline_aligned;
-- 
2.17.1


^ permalink raw reply	[flat|nested] 24+ messages in thread

* [PATCH v5 3/6] iio: adis: Add adis_update_bits() APIs
  2020-04-13  8:24 [PATCH v5 0/6] Support ADIS16475 and similar IMUs Nuno Sá
  2020-04-13  8:24 ` [PATCH v5 1/6] iio: imu: adis: Add Managed device functions Nuno Sá
  2020-04-13  8:24 ` [PATCH v5 2/6] iio: imu: adis: Add irq flag variable Nuno Sá
@ 2020-04-13  8:24 ` Nuno Sá
  2020-04-13  8:24 ` [PATCH v5 4/6] iio: adis: Support different burst sizes Nuno Sá
                   ` (3 subsequent siblings)
  6 siblings, 0 replies; 24+ messages in thread
From: Nuno Sá @ 2020-04-13  8:24 UTC (permalink / raw)
  To: linux-iio, devicetree
  Cc: Jonathan Cameron, Hartmut Knaack, Lars-Peter Clausen,
	Peter Meerwald-Stadler, Rob Herring, Mark Rutland,
	Alexandru Ardelean, Michael Hennerich

This patch adds a `regmap_update_bits()` like API to the ADIS library.
It provides locked and unlocked variant.

Signed-off-by: Nuno Sá <nuno.sa@analog.com>
---
Changes in v2:
 * Add BUILD_BUG_ON() to avoid invalid types.

Changes in V3:
 * Nothing changed.

Changes in v4:
 * Use one liner for updating the bits.

Changes in v5:
 * Nothing changed.

 drivers/iio/imu/adis.c       | 25 +++++++++++++++
 include/linux/iio/imu/adis.h | 59 ++++++++++++++++++++++++++++++++++++
 2 files changed, 84 insertions(+)

diff --git a/drivers/iio/imu/adis.c b/drivers/iio/imu/adis.c
index 2e7d0d337f8f..c539dfa3b8d3 100644
--- a/drivers/iio/imu/adis.c
+++ b/drivers/iio/imu/adis.c
@@ -223,6 +223,31 @@ int __adis_read_reg(struct adis *adis, unsigned int reg,
 	return ret;
 }
 EXPORT_SYMBOL_GPL(__adis_read_reg);
+/**
+ * __adis_update_bits_base() - ADIS Update bits function - Unlocked version
+ * @adis: The adis device
+ * @reg: The address of the lower of the two registers
+ * @mask: Bitmask to change
+ * @val: Value to be written
+ * @size: Size of the register to update
+ *
+ * Updates the desired bits of @reg in accordance with @mask and @val.
+ */
+int __adis_update_bits_base(struct adis *adis, unsigned int reg, const u32 mask,
+			    const u32 val, u8 size)
+{
+	int ret;
+	u32 __val;
+
+	ret = __adis_read_reg(adis, reg, &__val, size);
+	if (ret)
+		return ret;
+
+	__val = (__val & ~mask) | (val & mask);
+
+	return __adis_write_reg(adis, reg, __val, size);
+}
+EXPORT_SYMBOL_GPL(__adis_update_bits_base);
 
 #ifdef CONFIG_DEBUG_FS
 
diff --git a/include/linux/iio/imu/adis.h b/include/linux/iio/imu/adis.h
index 70e4d1d262f5..247fc4c7185c 100644
--- a/include/linux/iio/imu/adis.h
+++ b/include/linux/iio/imu/adis.h
@@ -333,6 +333,65 @@ static inline int adis_read_reg_32(struct adis *adis, unsigned int reg,
 	return ret;
 }
 
+int __adis_update_bits_base(struct adis *adis, unsigned int reg, const u32 mask,
+			    const u32 val, u8 size);
+/**
+ * adis_update_bits_base() - ADIS Update bits function - Locked version
+ * @adis: The adis device
+ * @reg: The address of the lower of the two registers
+ * @mask: Bitmask to change
+ * @val: Value to be written
+ * @size: Size of the register to update
+ *
+ * Updates the desired bits of @reg in accordance with @mask and @val.
+ */
+static inline int adis_update_bits_base(struct adis *adis, unsigned int reg,
+					const u32 mask, const u32 val, u8 size)
+{
+	int ret;
+
+	mutex_lock(&adis->state_lock);
+	ret = __adis_update_bits_base(adis, reg, mask, val, size);
+	mutex_unlock(&adis->state_lock);
+	return ret;
+}
+
+/**
+ * adis_update_bits() - Wrapper macro for adis_update_bits_base - Locked version
+ * @adis: The adis device
+ * @reg: The address of the lower of the two registers
+ * @mask: Bitmask to change
+ * @val: Value to be written
+ *
+ * This macro evaluates the sizeof of @val at compile time and calls
+ * adis_update_bits_base() accordingly. Be aware that using MACROS/DEFINES for
+ * @val can lead to undesired behavior if the register to update is 16bit.
+ */
+#define adis_update_bits(adis, reg, mask, val) ({			\
+	BUILD_BUG_ON(sizeof(val) == 1 || sizeof(val) == 8);		\
+	__builtin_choose_expr(sizeof(val) == 4,				\
+		adis_update_bits_base(adis, reg, mask, val, 4),         \
+		adis_update_bits_base(adis, reg, mask, val, 2));	\
+})
+
+/**
+ * adis_update_bits() - Wrapper macro for adis_update_bits_base
+ * @adis: The adis device
+ * @reg: The address of the lower of the two registers
+ * @mask: Bitmask to change
+ * @val: Value to be written
+ *
+ * This macro evaluates the sizeof of @val at compile time and calls
+ * adis_update_bits_base() accordingly. Be aware that using MACROS/DEFINES for
+ * @val can lead to undesired behavior if the register to update is 16bit.
+ */
+#define __adis_update_bits(adis, reg, mask, val) ({			\
+	BUILD_BUG_ON(sizeof(val) == 1 || sizeof(val) == 8);		\
+	__builtin_choose_expr(sizeof(val) == 4,				\
+		__adis_update_bits_base(adis, reg, mask, val, 4),	\
+		__adis_update_bits_base(adis, reg, mask, val, 2));	\
+})
+
 int adis_enable_irq(struct adis *adis, bool enable);
 int __adis_check_status(struct adis *adis);
 int __adis_initial_startup(struct adis *adis);
-- 
2.17.1


^ permalink raw reply	[flat|nested] 24+ messages in thread

* [PATCH v5 4/6] iio: adis: Support different burst sizes
  2020-04-13  8:24 [PATCH v5 0/6] Support ADIS16475 and similar IMUs Nuno Sá
                   ` (2 preceding siblings ...)
  2020-04-13  8:24 ` [PATCH v5 3/6] iio: adis: Add adis_update_bits() APIs Nuno Sá
@ 2020-04-13  8:24 ` Nuno Sá
  2020-04-13  8:24 ` [PATCH v5 5/6] iio: imu: Add support for adis16475 Nuno Sá
                   ` (2 subsequent siblings)
  6 siblings, 0 replies; 24+ messages in thread
From: Nuno Sá @ 2020-04-13  8:24 UTC (permalink / raw)
  To: linux-iio, devicetree
  Cc: Jonathan Cameron, Hartmut Knaack, Lars-Peter Clausen,
	Peter Meerwald-Stadler, Rob Herring, Mark Rutland,
	Alexandru Ardelean, Michael Hennerich

Add burst_max_len to `adis_burst`. This is useful for devices which
support different burst modes with different sizes. The buffer to be
used in the spi transfer is allocated with this variable making sure
that has space for all burst modes. The spi transfer length should hold
the "real" burst length depending on the current burst mode configured
in the device.

Moreover, `extra_len` in `adis_burst` is made const and it should
contain the smallest extra length necessary for a burst transfer. In
`struct adis` was added a new `burst_extra_len` that should hold the
extra bytes needed depending on the device instance being used.

Signed-off-by: Nuno Sá <nuno.sa@analog.com>
---
Changes in v2:
 * Nothing changed.

Changes in v3:
 * Reworked commit message;
 * Made `extra_len` const;
 * Added `burst_extra_len` to `struct adis`;
 * Changed adis16400 accordingly.

Changes in v4:
 * Nothing changed.

Changes in v5:
 * Nothing changed.

 drivers/iio/imu/adis16400.c   |  2 +-
 drivers/iio/imu/adis_buffer.c | 13 +++++++++----
 include/linux/iio/imu/adis.h  |  9 +++++++--
 3 files changed, 17 insertions(+), 7 deletions(-)

diff --git a/drivers/iio/imu/adis16400.c b/drivers/iio/imu/adis16400.c
index 4445c242709c..439feb755d82 100644
--- a/drivers/iio/imu/adis16400.c
+++ b/drivers/iio/imu/adis16400.c
@@ -1195,7 +1195,7 @@ static int adis16400_probe(struct spi_device *spi)
 		indio_dev->available_scan_masks = st->avail_scan_mask;
 		st->adis.burst = &adis16400_burst;
 		if (st->variant->flags & ADIS16400_BURST_DIAG_STAT)
-			st->adis.burst->extra_len = sizeof(u16);
+			st->adis.burst_extra_len = sizeof(u16);
 	}
 
 	adis16400_data = &st->variant->adis_data;
diff --git a/drivers/iio/imu/adis_buffer.c b/drivers/iio/imu/adis_buffer.c
index 8fdc4dca10c0..5b4225ee09b9 100644
--- a/drivers/iio/imu/adis_buffer.c
+++ b/drivers/iio/imu/adis_buffer.c
@@ -23,25 +23,30 @@ static int adis_update_scan_mode_burst(struct iio_dev *indio_dev,
 	const unsigned long *scan_mask)
 {
 	struct adis *adis = iio_device_get_drvdata(indio_dev);
-	unsigned int burst_length;
+	unsigned int burst_length, burst_max_length;
 	u8 *tx;
 
 	/* All but the timestamp channel */
 	burst_length = (indio_dev->num_channels - 1) * sizeof(u16);
-	burst_length += adis->burst->extra_len;
+	burst_length += adis->burst->extra_len + adis->burst_extra_len;
+
+	if (adis->burst->burst_max_len)
+		burst_max_length = adis->burst->burst_max_len;
+	else
+		burst_max_length = burst_length;
 
 	adis->xfer = kcalloc(2, sizeof(*adis->xfer), GFP_KERNEL);
 	if (!adis->xfer)
 		return -ENOMEM;
 
-	adis->buffer = kzalloc(burst_length + sizeof(u16), GFP_KERNEL);
+	adis->buffer = kzalloc(burst_max_length + sizeof(u16), GFP_KERNEL);
 	if (!adis->buffer) {
 		kfree(adis->xfer);
 		adis->xfer = NULL;
 		return -ENOMEM;
 	}
 
-	tx = adis->buffer + burst_length;
+	tx = adis->buffer + burst_max_length;
 	tx[0] = ADIS_READ_REG(adis->burst->reg_cmd);
 	tx[1] = 0;
 
diff --git a/include/linux/iio/imu/adis.h b/include/linux/iio/imu/adis.h
index 247fc4c7185c..2df67448f0d1 100644
--- a/include/linux/iio/imu/adis.h
+++ b/include/linux/iio/imu/adis.h
@@ -83,6 +83,8 @@ struct adis_data {
  * @trig: IIO trigger object data
  * @data: ADIS chip variant specific data
  * @burst: ADIS burst transfer information
+ * @burst_extra_len: Burst extra length. Should only be used by devices that can
+ *		     dynamically change their burst mode length.
  * @state_lock: Lock used by the device to protect state
  * @msg: SPI message object
  * @xfer: SPI transfer objects to be used for a @msg
@@ -98,7 +100,7 @@ struct adis {
 
 	const struct adis_data	*data;
 	struct adis_burst	*burst;
-
+	unsigned int		burst_extra_len;
 	/**
 	 * The state_lock is meant to be used during operations that require
 	 * a sequence of SPI R/W in order to protect the SPI transfer
@@ -502,11 +504,14 @@ int adis_single_conversion(struct iio_dev *indio_dev,
  * @en			burst mode enabled
  * @reg_cmd		register command that triggers burst
  * @extra_len		extra length to account in the SPI RX buffer
+ * @burst_max_len	holds the maximum burst size when the device supports
+ *			more than one burst mode with different sizes
  */
 struct adis_burst {
 	bool		en;
 	unsigned int	reg_cmd;
-	unsigned int	extra_len;
+	const u32	extra_len;
+	const u32	burst_max_len;
 };
 
 int
-- 
2.17.1


^ permalink raw reply	[flat|nested] 24+ messages in thread

* [PATCH v5 5/6] iio: imu: Add support for adis16475
  2020-04-13  8:24 [PATCH v5 0/6] Support ADIS16475 and similar IMUs Nuno Sá
                   ` (3 preceding siblings ...)
  2020-04-13  8:24 ` [PATCH v5 4/6] iio: adis: Support different burst sizes Nuno Sá
@ 2020-04-13  8:24 ` Nuno Sá
  2020-04-27 18:06   ` Lars-Peter Clausen
  2020-04-13  8:24 ` [PATCH v5 6/6] dt-bindings: iio: Add adis16475 documentation Nuno Sá
  2020-04-13 16:27 ` [PATCH v5 0/6] Support ADIS16475 and similar IMUs Jonathan Cameron
  6 siblings, 1 reply; 24+ messages in thread
From: Nuno Sá @ 2020-04-13  8:24 UTC (permalink / raw)
  To: linux-iio, devicetree
  Cc: Jonathan Cameron, Hartmut Knaack, Lars-Peter Clausen,
	Peter Meerwald-Stadler, Rob Herring, Mark Rutland,
	Alexandru Ardelean, Michael Hennerich

Support ADIS16475 and similar IMU devices. These devices are
a precision, miniature MEMS inertial measurement unit (IMU) that
includes a triaxial gyroscope and a triaxial accelerometer. Each
inertial sensor combines with signal conditioning that optimizes
dynamic performance.

The driver adds support for the following devices:
* adis16470, adis16475, adis16477, adis16465, adis16467, adis16500,
  adis16505, adis16507.

Signed-off-by: Nuno Sá <nuno.sa@analog.com>
---
Changes in v2:
 * Remove burst mode config (enabled by default);
 * Fix timestamp channel index;
 * Do return code checks inline in `adis16475_read_raw`;
 * Increase buffer size to fit aligned timestamp;
 * Remove spi_device_id table;
 * Rename `adis16475_clks` to `adis16475_sync`;
 * Rename `adis16475_config_ext_clk` `adis16475_config_sync_mode`;
 * Fix output-sync mode. There's no need to call clk_get in this mode as
it acts as an output pin;
 * Fix scaled-mode configuration. Up scale was not being written on the right register;
 * Handle burst32 configuration at runtime. When the decimation or the FIR filter is enabled
the LSB bits are meangninfull. Hence, use burst32 in that case (if the part supports it);
 * When there's no burst32 mode and the LSB data is meangninfull, read it manually...
 * Do not push data to buffers if crc is invalid.

Changes in V3:
 * Fix multiple instance devices for different burst sizes;
 * Only return error if `freq` is 0 on `adis16475_set_freq``;
 * Fixed typo in comment;
 * Do not allow 7 to be set in `adis16475_set_filter`;
 * Change `adis16475_validate_crc` return type to bool;
 * Return 1 if crc is valid instead of 0.

Changes in v4:
 * Remove unused file from MAINTAINERS;
 * Remove `<asm/unaligned.h>`;
 * Use `irq_flag` - Changed in 2 patch;
 * Use DEFINE_DEBUGFS_ATTRIBUTE + debugfs_create_file_unsafe;
 * No need to return in `adis16475_debugfs_init`;
 * Drop parentheses in (crc == 0);
 * Remove unnecessary casts;
 * Directly pass `data` to `iio_push_to_buffers_with_timestamp`;
 * Remove all get_unaligned calls;
 * Better indent macros with inside macros;
 * Use `assign_bit()`;
 * Drop `ret < 0` checks;
 * Use `device_get_match_data()`;
 * Replace `linux/of_device.h` by `<linux/mod_devicetable.h>`and `<linux/property.h>`;
 * Remove invalid index in `adis16475_3db_freqs`;
 * Make the loop in `adis16475_set_filter` more readable.

Changes in v5:
 * Added braces in while expression;
 * Removed extra blank line;
 * Add missing blank lines;
 * Removed redundant parentheses;
 * Use the correct irq type defines after `irqd_get_trigger_type`;
 * Explictly assign irq_flags even when IRQ_TYPE_EDGE_RISING;
 * Check return value of `device_property_read_u32` when checking adi,scaled-output-hz.

 MAINTAINERS                 |    7 +
 drivers/iio/imu/Kconfig     |   13 +
 drivers/iio/imu/Makefile    |    1 +
 drivers/iio/imu/adis16475.c | 1339 +++++++++++++++++++++++++++++++++++
 4 files changed, 1360 insertions(+)
 create mode 100644 drivers/iio/imu/adis16475.c

diff --git a/MAINTAINERS b/MAINTAINERS
index 8687cc5397c8..a2ff8322c184 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1009,6 +1009,13 @@ W:	http://ez.analog.com/community/linux-device-drivers
 F:	drivers/iio/imu/adis16460.c
 F:	Documentation/devicetree/bindings/iio/imu/adi,adis16460.yaml
 
+ANALOG DEVICES INC ADIS16475 DRIVER
+M:	Nuno Sa <nuno.sa@analog.com>
+L:	linux-iio@vger.kernel.org
+W:	http://ez.analog.com/community/linux-device-drivers
+S:	Supported
+F:	drivers/iio/imu/adis16475.c
+
 ANALOG DEVICES INC ADM1177 DRIVER
 M:	Beniamin Bia <beniamin.bia@analog.com>
 M:	Michael Hennerich <Michael.Hennerich@analog.com>
diff --git a/drivers/iio/imu/Kconfig b/drivers/iio/imu/Kconfig
index 60bb1029e759..fc4123d518bc 100644
--- a/drivers/iio/imu/Kconfig
+++ b/drivers/iio/imu/Kconfig
@@ -29,6 +29,19 @@ config ADIS16460
 	  To compile this driver as a module, choose M here: the module will be
 	  called adis16460.
 
+config ADIS16475
+	tristate "Analog Devices ADIS16475 and similar IMU driver"
+	depends on SPI
+	select IIO_ADIS_LIB
+	select IIO_ADIS_LIB_BUFFER if IIO_BUFFER
+	help
+	  Say yes here to build support for Analog Devices ADIS16470, ADIS16475,
+	  ADIS16477, ADIS16465, ADIS16467, ADIS16500, ADIS16505, ADIS16507 inertial
+	  sensors.
+
+	  To compile this driver as a module, choose M here: the module will be
+	  called adis16475.
+
 config ADIS16480
 	tristate "Analog Devices ADIS16480 and similar IMU driver"
 	depends on SPI
diff --git a/drivers/iio/imu/Makefile b/drivers/iio/imu/Makefile
index 5237fd4bc384..88b2c4555230 100644
--- a/drivers/iio/imu/Makefile
+++ b/drivers/iio/imu/Makefile
@@ -6,6 +6,7 @@
 # When adding new entries keep the list in alphabetical order
 obj-$(CONFIG_ADIS16400) += adis16400.o
 obj-$(CONFIG_ADIS16460) += adis16460.o
+obj-$(CONFIG_ADIS16475) += adis16475.o
 obj-$(CONFIG_ADIS16480) += adis16480.o
 
 adis_lib-y += adis.o
diff --git a/drivers/iio/imu/adis16475.c b/drivers/iio/imu/adis16475.c
new file mode 100644
index 000000000000..e2bd4214eaeb
--- /dev/null
+++ b/drivers/iio/imu/adis16475.c
@@ -0,0 +1,1339 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * ADIS16475 IMU driver
+ *
+ * Copyright 2019 Analog Devices Inc.
+ */
+#include <linux/bitfield.h>
+#include <linux/bitops.h>
+#include <linux/clk.h>
+#include <linux/debugfs.h>
+#include <linux/delay.h>
+#include <linux/device.h>
+#include <linux/kernel.h>
+#include <linux/iio/buffer.h>
+#include <linux/iio/iio.h>
+#include <linux/iio/imu/adis.h>
+#include <linux/iio/sysfs.h>
+#include <linux/iio/trigger_consumer.h>
+#include <linux/irq.h>
+#include <linux/module.h>
+#include <linux/mod_devicetable.h>
+#include <linux/property.h>
+#include <linux/spi/spi.h>
+
+#define ADIS16475_REG_DIAG_STAT		0x02
+#define ADIS16475_REG_X_GYRO_L		0x04
+#define ADIS16475_REG_Y_GYRO_L		0x08
+#define ADIS16475_REG_Z_GYRO_L		0x0C
+#define ADIS16475_REG_X_ACCEL_L		0x10
+#define ADIS16475_REG_Y_ACCEL_L		0x14
+#define ADIS16475_REG_Z_ACCEL_L		0x18
+#define ADIS16475_REG_TEMP_OUT		0x1c
+#define ADIS16475_REG_X_GYRO_BIAS_L	0x40
+#define ADIS16475_REG_Y_GYRO_BIAS_L	0x44
+#define ADIS16475_REG_Z_GYRO_BIAS_L	0x48
+#define ADIS16475_REG_X_ACCEL_BIAS_L	0x4c
+#define ADIS16475_REG_Y_ACCEL_BIAS_L	0x50
+#define ADIS16475_REG_Z_ACCEL_BIAS_L	0x54
+#define ADIS16475_REG_FILT_CTRL		0x5c
+#define ADIS16475_FILT_CTRL_MASK	GENMASK(2, 0)
+#define ADIS16475_FILT_CTRL(x)		FIELD_PREP(ADIS16475_FILT_CTRL_MASK, x)
+#define ADIS16475_REG_MSG_CTRL		0x60
+#define ADIS16475_MSG_CTRL_DR_POL_MASK	BIT(0)
+#define ADIS16475_MSG_CTRL_DR_POL(x) \
+				FIELD_PREP(ADIS16475_MSG_CTRL_DR_POL_MASK, x)
+#define ADIS16475_SYNC_MODE_MASK	GENMASK(4, 2)
+#define ADIS16475_SYNC_MODE(x)		FIELD_PREP(ADIS16475_SYNC_MODE_MASK, x)
+#define ADIS16475_REG_UP_SCALE		0x62
+#define ADIS16475_REG_DEC_RATE		0x64
+#define ADIS16475_REG_GLOB_CMD		0x68
+#define ADIS16475_REG_FIRM_REV		0x6c
+#define ADIS16475_REG_FIRM_DM		0x6e
+#define ADIS16475_REG_FIRM_Y		0x70
+#define ADIS16475_REG_PROD_ID		0x72
+#define ADIS16475_REG_SERIAL_NUM	0x74
+#define ADIS16475_REG_FLASH_CNT		0x7c
+#define ADIS16500_BURST32_MASK		BIT(9)
+#define ADIS16500_BURST32(x)		FIELD_PREP(ADIS16500_BURST32_MASK, x)
+/* number of data elements in burst mode */
+#define ADIS16475_BURST32_MAX_DATA	32
+#define ADIS16475_BURST_MAX_DATA	20
+#define ADIS16475_MAX_SCAN_DATA		20
+/* spi max speed in brust mode */
+#define ADIS16475_BURST_MAX_SPEED	1000000
+#define ADIS16475_LSB_DEC_MASK		BIT(0)
+#define ADIS16475_LSB_FIR_MASK		BIT(1)
+
+enum {
+	ADIS16475_SYNC_DIRECT = 1,
+	ADIS16475_SYNC_SCALED,
+	ADIS16475_SYNC_OUTPUT,
+	ADIS16475_SYNC_PULSE = 5,
+};
+
+struct adis16475_sync {
+	u16 sync_mode;
+	u16 min_rate;
+	u16 max_rate;
+};
+
+struct adis16475_chip_info {
+	const struct iio_chan_spec *channels;
+	const struct adis16475_sync *sync;
+	const struct adis_data adis_data;
+	const char *name;
+	u32 num_channels;
+	u32 gyro_max_val;
+	u32 gyro_max_scale;
+	u32 accel_max_val;
+	u32 accel_max_scale;
+	u32 temp_scale;
+	u32 int_clk;
+	u16 max_dec;
+	u8 num_sync;
+	bool has_burst32;
+};
+
+struct adis16475 {
+	const struct adis16475_chip_info *info;
+	struct adis adis;
+	u32 clk_freq;
+	bool burst32;
+	unsigned long lsb_flag;
+};
+
+enum {
+	ADIS16475_SCAN_GYRO_X,
+	ADIS16475_SCAN_GYRO_Y,
+	ADIS16475_SCAN_GYRO_Z,
+	ADIS16475_SCAN_ACCEL_X,
+	ADIS16475_SCAN_ACCEL_Y,
+	ADIS16475_SCAN_ACCEL_Z,
+	ADIS16475_SCAN_TEMP,
+	ADIS16475_SCAN_DIAG_S_FLAGS,
+	ADIS16475_SCAN_CRC_FAILURE,
+};
+
+#ifdef CONFIG_DEBUG_FS
+static ssize_t adis16475_show_firmware_revision(struct file *file,
+						char __user *userbuf,
+						size_t count, loff_t *ppos)
+{
+	struct adis16475 *st = file->private_data;
+	char buf[7];
+	size_t len;
+	u16 rev;
+	int ret;
+
+	ret = adis_read_reg_16(&st->adis, ADIS16475_REG_FIRM_REV, &rev);
+	if (ret)
+		return ret;
+
+	len = scnprintf(buf, sizeof(buf), "%x.%x\n", rev >> 8, rev & 0xff);
+
+	return simple_read_from_buffer(userbuf, count, ppos, buf, len);
+}
+
+static const struct file_operations adis16475_firmware_revision_fops = {
+	.open = simple_open,
+	.read = adis16475_show_firmware_revision,
+	.llseek = default_llseek,
+	.owner = THIS_MODULE,
+};
+
+static ssize_t adis16475_show_firmware_date(struct file *file,
+					    char __user *userbuf,
+					    size_t count, loff_t *ppos)
+{
+	struct adis16475 *st = file->private_data;
+	u16 md, year;
+	char buf[12];
+	size_t len;
+	int ret;
+
+	ret = adis_read_reg_16(&st->adis, ADIS16475_REG_FIRM_Y, &year);
+	if (ret)
+		return ret;
+
+	ret = adis_read_reg_16(&st->adis, ADIS16475_REG_FIRM_DM, &md);
+	if (ret)
+		return ret;
+
+	len = snprintf(buf, sizeof(buf), "%.2x-%.2x-%.4x\n", md >> 8, md & 0xff,
+		       year);
+
+	return simple_read_from_buffer(userbuf, count, ppos, buf, len);
+}
+
+static const struct file_operations adis16475_firmware_date_fops = {
+	.open = simple_open,
+	.read = adis16475_show_firmware_date,
+	.llseek = default_llseek,
+	.owner = THIS_MODULE,
+};
+
+static int adis16475_show_serial_number(void *arg, u64 *val)
+{
+	struct adis16475 *st = arg;
+	u16 serial;
+	int ret;
+
+	ret = adis_read_reg_16(&st->adis, ADIS16475_REG_SERIAL_NUM, &serial);
+	if (ret)
+		return ret;
+
+	*val = serial;
+
+	return 0;
+}
+DEFINE_DEBUGFS_ATTRIBUTE(adis16475_serial_number_fops,
+			 adis16475_show_serial_number, NULL, "0x%.4llx\n");
+
+static int adis16475_show_product_id(void *arg, u64 *val)
+{
+	struct adis16475 *st = arg;
+	u16 prod_id;
+	int ret;
+
+	ret = adis_read_reg_16(&st->adis, ADIS16475_REG_PROD_ID, &prod_id);
+	if (ret)
+		return ret;
+
+	*val = prod_id;
+
+	return 0;
+}
+DEFINE_DEBUGFS_ATTRIBUTE(adis16475_product_id_fops,
+			 adis16475_show_product_id, NULL, "%llu\n");
+
+static int adis16475_show_flash_count(void *arg, u64 *val)
+{
+	struct adis16475 *st = arg;
+	u32 flash_count;
+	int ret;
+
+	ret = adis_read_reg_32(&st->adis, ADIS16475_REG_FLASH_CNT,
+			       &flash_count);
+	if (ret)
+		return ret;
+
+	*val = flash_count;
+
+	return 0;
+}
+DEFINE_DEBUGFS_ATTRIBUTE(adis16475_flash_count_fops,
+			 adis16475_show_flash_count, NULL, "%lld\n");
+
+static void adis16475_debugfs_init(struct iio_dev *indio_dev)
+{
+	struct adis16475 *st = iio_priv(indio_dev);
+
+	debugfs_create_file_unsafe("serial_number", 0400,
+				   indio_dev->debugfs_dentry, st,
+				   &adis16475_serial_number_fops);
+	debugfs_create_file_unsafe("product_id", 0400,
+				   indio_dev->debugfs_dentry, st,
+				   &adis16475_product_id_fops);
+	debugfs_create_file_unsafe("flash_count", 0400,
+				   indio_dev->debugfs_dentry, st,
+				   &adis16475_flash_count_fops);
+	debugfs_create_file("firmware_revision", 0400,
+			    indio_dev->debugfs_dentry, st,
+			    &adis16475_firmware_revision_fops);
+	debugfs_create_file("firmware_date", 0400, indio_dev->debugfs_dentry,
+			    st, &adis16475_firmware_date_fops);
+}
+#else
+static void adis16475_debugfs_init(struct iio_dev *indio_dev)
+{
+}
+#endif
+
+static int adis16475_get_freq(struct adis16475 *st, u32 *freq)
+{
+	int ret;
+	u16 dec;
+
+	ret = adis_read_reg_16(&st->adis, ADIS16475_REG_DEC_RATE, &dec);
+	if (ret)
+		return -EINVAL;
+
+	*freq = DIV_ROUND_CLOSEST(st->clk_freq, dec + 1);
+
+	return 0;
+}
+
+static int adis16475_set_freq(struct adis16475 *st, const u32 freq)
+{
+	u16 dec;
+	int ret;
+
+	if (!freq)
+		return -EINVAL;
+
+	dec = DIV_ROUND_CLOSEST(st->clk_freq, freq);
+
+	if (dec)
+		dec--;
+
+	if (dec > st->info->max_dec)
+		dec = st->info->max_dec;
+
+	ret = adis_write_reg_16(&st->adis, ADIS16475_REG_DEC_RATE, dec);
+	if (ret)
+		return ret;
+
+	/*
+	 * If decimation is used, then gyro and accel data will have meaningful
+	 * bits on the LSB registers. This info is used on the trigger handler.
+	 */
+	assign_bit(ADIS16475_LSB_DEC_MASK, &st->lsb_flag, dec);
+
+	return 0;
+}
+
+/* The values are approximated. */
+static const u32 adis16475_3db_freqs[] = {
+	[0] = 720, /* Filter disabled, full BW (~720Hz) */
+	[1] = 360,
+	[2] = 164,
+	[3] = 80,
+	[4] = 40,
+	[5] = 20,
+	[6] = 10,
+};
+
+static int adis16475_get_filter(struct adis16475 *st, u32 *filter)
+{
+	u16 filter_sz;
+	int ret;
+	const int mask = ADIS16475_FILT_CTRL_MASK;
+
+	ret = adis_read_reg_16(&st->adis, ADIS16475_REG_FILT_CTRL, &filter_sz);
+	if (ret)
+		return ret;
+
+	*filter = adis16475_3db_freqs[filter_sz & mask];
+
+	return 0;
+}
+
+static int adis16475_set_filter(struct adis16475 *st, const u32 filter)
+{
+	int i = ARRAY_SIZE(adis16475_3db_freqs);
+	int ret;
+
+	while (--i) {
+		if (adis16475_3db_freqs[i] >= filter)
+			break;
+	}
+
+	ret = adis_write_reg_16(&st->adis, ADIS16475_REG_FILT_CTRL,
+				ADIS16475_FILT_CTRL(i));
+	if (ret)
+		return ret;
+
+	/*
+	 * If FIR is used, then gyro and accel data will have meaningful
+	 * bits on the LSB registers. This info is used on the trigger handler.
+	 */
+	assign_bit(ADIS16475_LSB_FIR_MASK, &st->lsb_flag, i);
+
+	return 0;
+}
+
+static const u32 adis16475_calib_regs[] = {
+	[ADIS16475_SCAN_GYRO_X] = ADIS16475_REG_X_GYRO_BIAS_L,
+	[ADIS16475_SCAN_GYRO_Y] = ADIS16475_REG_Y_GYRO_BIAS_L,
+	[ADIS16475_SCAN_GYRO_Z] = ADIS16475_REG_Z_GYRO_BIAS_L,
+	[ADIS16475_SCAN_ACCEL_X] = ADIS16475_REG_X_ACCEL_BIAS_L,
+	[ADIS16475_SCAN_ACCEL_Y] = ADIS16475_REG_Y_ACCEL_BIAS_L,
+	[ADIS16475_SCAN_ACCEL_Z] = ADIS16475_REG_Z_ACCEL_BIAS_L,
+};
+
+static int adis16475_read_raw(struct iio_dev *indio_dev,
+			      const struct iio_chan_spec *chan,
+			      int *val, int *val2, long info)
+{
+	struct adis16475 *st = iio_priv(indio_dev);
+	int ret;
+	u32 tmp;
+
+	switch (info) {
+	case IIO_CHAN_INFO_RAW:
+		return adis_single_conversion(indio_dev, chan, 0, val);
+	case IIO_CHAN_INFO_SCALE:
+		switch (chan->type) {
+		case IIO_ANGL_VEL:
+			*val = st->info->gyro_max_val;
+			*val2 = st->info->gyro_max_scale;
+			return IIO_VAL_FRACTIONAL;
+		case IIO_ACCEL:
+			*val = st->info->accel_max_val;
+			*val2 = st->info->accel_max_scale;
+			return IIO_VAL_FRACTIONAL;
+		case IIO_TEMP:
+			*val = st->info->temp_scale;
+			return IIO_VAL_INT;
+		default:
+			return -EINVAL;
+		}
+	case IIO_CHAN_INFO_CALIBBIAS:
+		ret = adis_read_reg_32(&st->adis,
+				       adis16475_calib_regs[chan->scan_index],
+				       val);
+		if (ret)
+			return ret;
+
+		return IIO_VAL_INT;
+	case IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY:
+		ret = adis16475_get_filter(st, val);
+		if (ret)
+			return ret;
+
+		return IIO_VAL_INT;
+	case IIO_CHAN_INFO_SAMP_FREQ:
+		ret = adis16475_get_freq(st, &tmp);
+		if (ret)
+			return ret;
+
+		*val = tmp / 1000;
+		*val2 = (tmp % 1000) * 1000;
+		return IIO_VAL_INT_PLUS_MICRO;
+	default:
+		return -EINVAL;
+	}
+}
+
+static int adis16475_write_raw(struct iio_dev *indio_dev,
+			       const struct iio_chan_spec *chan,
+			       int val, int val2, long info)
+{
+	struct adis16475 *st = iio_priv(indio_dev);
+	u32 tmp;
+
+	switch (info) {
+	case IIO_CHAN_INFO_SAMP_FREQ:
+		tmp = val * 1000 + val2 / 1000;
+		return adis16475_set_freq(st, tmp);
+	case IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY:
+		return adis16475_set_filter(st, val);
+	case IIO_CHAN_INFO_CALIBBIAS:
+		return adis_write_reg_32(&st->adis,
+					 adis16475_calib_regs[chan->scan_index],
+					 val);
+	default:
+		return -EINVAL;
+	}
+}
+
+#define ADIS16475_MOD_CHAN(_type, _mod, _address, _si, _r_bits, _s_bits) \
+	{ \
+		.type = (_type), \
+		.modified = 1, \
+		.channel2 = (_mod), \
+		.info_mask_separate = BIT(IIO_CHAN_INFO_RAW) | \
+			BIT(IIO_CHAN_INFO_CALIBBIAS), \
+		.info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE), \
+		.info_mask_shared_by_all = BIT(IIO_CHAN_INFO_SAMP_FREQ) | \
+			BIT(IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY), \
+		.address = (_address), \
+		.scan_index = (_si), \
+		.scan_type = { \
+			.sign = 's', \
+			.realbits = (_r_bits), \
+			.storagebits = (_s_bits), \
+			.endianness = IIO_BE, \
+		}, \
+	}
+
+#define ADIS16475_GYRO_CHANNEL(_mod) \
+	ADIS16475_MOD_CHAN(IIO_ANGL_VEL, IIO_MOD_ ## _mod, \
+			   ADIS16475_REG_ ## _mod ## _GYRO_L, \
+			   ADIS16475_SCAN_GYRO_ ## _mod, 32, 32)
+
+#define ADIS16475_ACCEL_CHANNEL(_mod) \
+	ADIS16475_MOD_CHAN(IIO_ACCEL, IIO_MOD_ ## _mod, \
+			   ADIS16475_REG_ ## _mod ## _ACCEL_L, \
+			   ADIS16475_SCAN_ACCEL_ ## _mod, 32, 32)
+
+#define ADIS16475_TEMP_CHANNEL() { \
+		.type = IIO_TEMP, \
+		.indexed = 1, \
+		.channel = 0, \
+		.info_mask_separate = BIT(IIO_CHAN_INFO_RAW) | \
+			BIT(IIO_CHAN_INFO_SCALE), \
+		.info_mask_shared_by_all = BIT(IIO_CHAN_INFO_SAMP_FREQ) | \
+			BIT(IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY), \
+		.address = ADIS16475_REG_TEMP_OUT, \
+		.scan_index = ADIS16475_SCAN_TEMP, \
+		.scan_type = { \
+			.sign = 's', \
+			.realbits = 16, \
+			.storagebits = 16, \
+			.endianness = IIO_BE, \
+		}, \
+	}
+
+static const struct iio_chan_spec adis16475_channels[] = {
+	ADIS16475_GYRO_CHANNEL(X),
+	ADIS16475_GYRO_CHANNEL(Y),
+	ADIS16475_GYRO_CHANNEL(Z),
+	ADIS16475_ACCEL_CHANNEL(X),
+	ADIS16475_ACCEL_CHANNEL(Y),
+	ADIS16475_ACCEL_CHANNEL(Z),
+	ADIS16475_TEMP_CHANNEL(),
+	IIO_CHAN_SOFT_TIMESTAMP(7)
+};
+
+enum adis16475_variant {
+	ADIS16470,
+	ADIS16475_1,
+	ADIS16475_2,
+	ADIS16475_3,
+	ADIS16477_1,
+	ADIS16477_2,
+	ADIS16477_3,
+	ADIS16465_1,
+	ADIS16465_2,
+	ADIS16465_3,
+	ADIS16467_1,
+	ADIS16467_2,
+	ADIS16467_3,
+	ADIS16500,
+	ADIS16505_1,
+	ADIS16505_2,
+	ADIS16505_3,
+	ADIS16507_1,
+	ADIS16507_2,
+	ADIS16507_3,
+};
+
+enum {
+	ADIS16475_DIAG_STAT_DATA_PATH = 1,
+	ADIS16475_DIAG_STAT_FLASH_MEM,
+	ADIS16475_DIAG_STAT_SPI,
+	ADIS16475_DIAG_STAT_STANDBY,
+	ADIS16475_DIAG_STAT_SENSOR,
+	ADIS16475_DIAG_STAT_MEMORY,
+	ADIS16475_DIAG_STAT_CLK,
+};
+
+static const char * const adis16475_status_error_msgs[] = {
+	[ADIS16475_DIAG_STAT_DATA_PATH] = "Data Path Overrun",
+	[ADIS16475_DIAG_STAT_FLASH_MEM] = "Flash memory update failure",
+	[ADIS16475_DIAG_STAT_SPI] = "SPI communication error",
+	[ADIS16475_DIAG_STAT_STANDBY] = "Standby mode",
+	[ADIS16475_DIAG_STAT_SENSOR] = "Sensor failure",
+	[ADIS16475_DIAG_STAT_MEMORY] = "Memory failure",
+	[ADIS16475_DIAG_STAT_CLK] = "Clock error",
+};
+
+static int adis16475_enable_irq(struct adis *adis, bool enable)
+{
+	/*
+	 * There is no way to gate the data-ready signal internally inside the
+	 * ADIS16475. We can only control it's polarity...
+	 */
+	if (enable)
+		enable_irq(adis->spi->irq);
+	else
+		disable_irq(adis->spi->irq);
+
+	return 0;
+}
+
+#define ADIS16475_DATA(_prod_id, _timeouts)				\
+{									\
+	.msc_ctrl_reg = ADIS16475_REG_MSG_CTRL,				\
+	.glob_cmd_reg = ADIS16475_REG_GLOB_CMD,				\
+	.diag_stat_reg = ADIS16475_REG_DIAG_STAT,			\
+	.prod_id_reg = ADIS16475_REG_PROD_ID,				\
+	.prod_id = (_prod_id),						\
+	.self_test_mask = BIT(2),					\
+	.self_test_reg = ADIS16475_REG_GLOB_CMD,			\
+	.cs_change_delay = 16,						\
+	.read_delay = 5,						\
+	.write_delay = 5,						\
+	.status_error_msgs = adis16475_status_error_msgs,		\
+	.status_error_mask = BIT(ADIS16475_DIAG_STAT_DATA_PATH) |	\
+		BIT(ADIS16475_DIAG_STAT_FLASH_MEM) |			\
+		BIT(ADIS16475_DIAG_STAT_SPI) |				\
+		BIT(ADIS16475_DIAG_STAT_STANDBY) |			\
+		BIT(ADIS16475_DIAG_STAT_SENSOR) |			\
+		BIT(ADIS16475_DIAG_STAT_MEMORY) |			\
+		BIT(ADIS16475_DIAG_STAT_CLK),				\
+	.enable_irq = adis16475_enable_irq,				\
+	.timeouts = (_timeouts),					\
+}
+
+static const struct adis16475_sync adis16475_sync_mode[] = {
+	{ ADIS16475_SYNC_OUTPUT },
+	{ ADIS16475_SYNC_DIRECT, 1900, 2100 },
+	{ ADIS16475_SYNC_SCALED, 1, 128 },
+	{ ADIS16475_SYNC_PULSE, 1000, 2100 },
+};
+
+static const struct adis_timeout adis16475_timeouts = {
+	.reset_ms = 200,
+	.sw_reset_ms = 200,
+	.self_test_ms = 20,
+};
+
+static const struct adis_timeout adis1650x_timeouts = {
+	.reset_ms = 260,
+	.sw_reset_ms = 260,
+	.self_test_ms = 30,
+};
+
+static const struct adis16475_chip_info adis16475_chip_info[] = {
+	[ADIS16470] = {
+		.name = "adis16470",
+		.num_channels = ARRAY_SIZE(adis16475_channels),
+		.channels = adis16475_channels,
+		.gyro_max_val = 1,
+		.gyro_max_scale = IIO_RAD_TO_DEGREE(10 << 16),
+		.accel_max_val = 1,
+		.accel_max_scale = IIO_M_S_2_TO_G(800 << 16),
+		.temp_scale = 100,
+		.int_clk = 2000,
+		.max_dec = 1999,
+		.sync = adis16475_sync_mode,
+		.num_sync = ARRAY_SIZE(adis16475_sync_mode),
+		.adis_data = ADIS16475_DATA(16470, &adis16475_timeouts),
+	},
+	[ADIS16475_1] = {
+		.name = "adis16475-1",
+		.num_channels = ARRAY_SIZE(adis16475_channels),
+		.channels = adis16475_channels,
+		.gyro_max_val = 1,
+		.gyro_max_scale = IIO_RAD_TO_DEGREE(160 << 16),
+		.accel_max_val = 1,
+		.accel_max_scale = IIO_M_S_2_TO_G(4000 << 16),
+		.temp_scale = 100,
+		.int_clk = 2000,
+		.max_dec = 1999,
+		.sync = adis16475_sync_mode,
+		.num_sync = ARRAY_SIZE(adis16475_sync_mode),
+		.adis_data = ADIS16475_DATA(16475, &adis16475_timeouts),
+	},
+	[ADIS16475_2] = {
+		.name = "adis16475-2",
+		.num_channels = ARRAY_SIZE(adis16475_channels),
+		.channels = adis16475_channels,
+		.gyro_max_val = 1,
+		.gyro_max_scale = IIO_RAD_TO_DEGREE(40 << 16),
+		.accel_max_val = 1,
+		.accel_max_scale = IIO_M_S_2_TO_G(4000 << 16),
+		.temp_scale = 100,
+		.int_clk = 2000,
+		.max_dec = 1999,
+		.sync = adis16475_sync_mode,
+		.num_sync = ARRAY_SIZE(adis16475_sync_mode),
+		.adis_data = ADIS16475_DATA(16475, &adis16475_timeouts),
+	},
+	[ADIS16475_3] = {
+		.name = "adis16475-3",
+		.num_channels = ARRAY_SIZE(adis16475_channels),
+		.channels = adis16475_channels,
+		.gyro_max_val = 1,
+		.gyro_max_scale = IIO_RAD_TO_DEGREE(10 << 16),
+		.accel_max_val = 1,
+		.accel_max_scale = IIO_M_S_2_TO_G(4000 << 16),
+		.temp_scale = 100,
+		.int_clk = 2000,
+		.max_dec = 1999,
+		.sync = adis16475_sync_mode,
+		.num_sync = ARRAY_SIZE(adis16475_sync_mode),
+		.adis_data = ADIS16475_DATA(16475, &adis16475_timeouts),
+	},
+	[ADIS16477_1] = {
+		.name = "adis16477-1",
+		.num_channels = ARRAY_SIZE(adis16475_channels),
+		.channels = adis16475_channels,
+		.gyro_max_val = 1,
+		.gyro_max_scale = IIO_RAD_TO_DEGREE(160 << 16),
+		.accel_max_val = 1,
+		.accel_max_scale = IIO_M_S_2_TO_G(800 << 16),
+		.temp_scale = 100,
+		.int_clk = 2000,
+		.max_dec = 1999,
+		.sync = adis16475_sync_mode,
+		.num_sync = ARRAY_SIZE(adis16475_sync_mode),
+		.adis_data = ADIS16475_DATA(16477, &adis16475_timeouts),
+	},
+	[ADIS16477_2] = {
+		.name = "adis16477-2",
+		.num_channels = ARRAY_SIZE(adis16475_channels),
+		.channels = adis16475_channels,
+		.gyro_max_val = 1,
+		.gyro_max_scale = IIO_RAD_TO_DEGREE(40 << 16),
+		.accel_max_val = 1,
+		.accel_max_scale = IIO_M_S_2_TO_G(800 << 16),
+		.temp_scale = 100,
+		.int_clk = 2000,
+		.max_dec = 1999,
+		.sync = adis16475_sync_mode,
+		.num_sync = ARRAY_SIZE(adis16475_sync_mode),
+		.adis_data = ADIS16475_DATA(16477, &adis16475_timeouts),
+	},
+	[ADIS16477_3] = {
+		.name = "adis16477-3",
+		.num_channels = ARRAY_SIZE(adis16475_channels),
+		.channels = adis16475_channels,
+		.gyro_max_val = 1,
+		.gyro_max_scale = IIO_RAD_TO_DEGREE(10 << 16),
+		.accel_max_val = 1,
+		.accel_max_scale = IIO_M_S_2_TO_G(800 << 16),
+		.temp_scale = 100,
+		.int_clk = 2000,
+		.max_dec = 1999,
+		.sync = adis16475_sync_mode,
+		.num_sync = ARRAY_SIZE(adis16475_sync_mode),
+		.adis_data = ADIS16475_DATA(16477, &adis16475_timeouts),
+	},
+	[ADIS16465_1] = {
+		.name = "adis16465-1",
+		.num_channels = ARRAY_SIZE(adis16475_channels),
+		.channels = adis16475_channels,
+		.gyro_max_val = 1,
+		.gyro_max_scale = IIO_RAD_TO_DEGREE(160 << 16),
+		.accel_max_val = 1,
+		.accel_max_scale = IIO_M_S_2_TO_G(4000 << 16),
+		.temp_scale = 100,
+		.int_clk = 2000,
+		.max_dec = 1999,
+		.sync = adis16475_sync_mode,
+		.num_sync = ARRAY_SIZE(adis16475_sync_mode),
+		.adis_data = ADIS16475_DATA(16465, &adis16475_timeouts),
+	},
+	[ADIS16465_2] = {
+		.name = "adis16465-2",
+		.num_channels = ARRAY_SIZE(adis16475_channels),
+		.channels = adis16475_channels,
+		.gyro_max_val = 1,
+		.gyro_max_scale = IIO_RAD_TO_DEGREE(40 << 16),
+		.accel_max_val = 1,
+		.accel_max_scale = IIO_M_S_2_TO_G(4000 << 16),
+		.temp_scale = 100,
+		.int_clk = 2000,
+		.max_dec = 1999,
+		.sync = adis16475_sync_mode,
+		.num_sync = ARRAY_SIZE(adis16475_sync_mode),
+		.adis_data = ADIS16475_DATA(16465, &adis16475_timeouts),
+	},
+	[ADIS16465_3] = {
+		.name = "adis16465-3",
+		.num_channels = ARRAY_SIZE(adis16475_channels),
+		.channels = adis16475_channels,
+		.gyro_max_val = 1,
+		.gyro_max_scale = IIO_RAD_TO_DEGREE(10 << 16),
+		.accel_max_val = 1,
+		.accel_max_scale = IIO_M_S_2_TO_G(4000 << 16),
+		.temp_scale = 100,
+		.int_clk = 2000,
+		.max_dec = 1999,
+		.sync = adis16475_sync_mode,
+		.num_sync = ARRAY_SIZE(adis16475_sync_mode),
+		.adis_data = ADIS16475_DATA(16465, &adis16475_timeouts),
+	},
+	[ADIS16467_1] = {
+		.name = "adis16467-1",
+		.num_channels = ARRAY_SIZE(adis16475_channels),
+		.channels = adis16475_channels,
+		.gyro_max_val = 1,
+		.gyro_max_scale = IIO_RAD_TO_DEGREE(160 << 16),
+		.accel_max_val = 1,
+		.accel_max_scale = IIO_M_S_2_TO_G(800 << 16),
+		.temp_scale = 100,
+		.int_clk = 2000,
+		.max_dec = 1999,
+		.sync = adis16475_sync_mode,
+		.num_sync = ARRAY_SIZE(adis16475_sync_mode),
+		.adis_data = ADIS16475_DATA(16467, &adis16475_timeouts),
+	},
+	[ADIS16467_2] = {
+		.name = "adis16467-2",
+		.num_channels = ARRAY_SIZE(adis16475_channels),
+		.channels = adis16475_channels,
+		.gyro_max_val = 1,
+		.gyro_max_scale = IIO_RAD_TO_DEGREE(40 << 16),
+		.accel_max_val = 1,
+		.accel_max_scale = IIO_M_S_2_TO_G(800 << 16),
+		.temp_scale = 100,
+		.int_clk = 2000,
+		.max_dec = 1999,
+		.sync = adis16475_sync_mode,
+		.num_sync = ARRAY_SIZE(adis16475_sync_mode),
+		.adis_data = ADIS16475_DATA(16467, &adis16475_timeouts),
+	},
+	[ADIS16467_3] = {
+		.name = "adis16467-3",
+		.num_channels = ARRAY_SIZE(adis16475_channels),
+		.channels = adis16475_channels,
+		.gyro_max_val = 1,
+		.gyro_max_scale = IIO_RAD_TO_DEGREE(10 << 16),
+		.accel_max_val = 1,
+		.accel_max_scale = IIO_M_S_2_TO_G(800 << 16),
+		.temp_scale = 100,
+		.int_clk = 2000,
+		.max_dec = 1999,
+		.sync = adis16475_sync_mode,
+		.num_sync = ARRAY_SIZE(adis16475_sync_mode),
+		.adis_data = ADIS16475_DATA(16467, &adis16475_timeouts),
+	},
+	[ADIS16500] = {
+		.name = "adis16500",
+		.num_channels = ARRAY_SIZE(adis16475_channels),
+		.channels = adis16475_channels,
+		.gyro_max_val = 1,
+		.gyro_max_scale = IIO_RAD_TO_DEGREE(10 << 16),
+		.accel_max_val = 392,
+		.accel_max_scale = 32000 << 16,
+		.temp_scale = 100,
+		.int_clk = 2000,
+		.max_dec = 1999,
+		.sync = adis16475_sync_mode,
+		/* pulse sync not supported */
+		.num_sync = ARRAY_SIZE(adis16475_sync_mode) - 1,
+		.has_burst32 = true,
+		.adis_data = ADIS16475_DATA(16500, &adis1650x_timeouts),
+	},
+	[ADIS16505_1] = {
+		.name = "adis16505-1",
+		.num_channels = ARRAY_SIZE(adis16475_channels),
+		.channels = adis16475_channels,
+		.gyro_max_val = 1,
+		.gyro_max_scale = IIO_RAD_TO_DEGREE(160 << 16),
+		.accel_max_val = 78,
+		.accel_max_scale = 32000 << 16,
+		.temp_scale = 100,
+		.int_clk = 2000,
+		.max_dec = 1999,
+		.sync = adis16475_sync_mode,
+		/* pulse sync not supported */
+		.num_sync = ARRAY_SIZE(adis16475_sync_mode) - 1,
+		.has_burst32 = true,
+		.adis_data = ADIS16475_DATA(16505, &adis1650x_timeouts),
+	},
+	[ADIS16505_2] = {
+		.name = "adis16505-2",
+		.num_channels = ARRAY_SIZE(adis16475_channels),
+		.channels = adis16475_channels,
+		.gyro_max_val = 1,
+		.gyro_max_scale = IIO_RAD_TO_DEGREE(40 << 16),
+		.accel_max_val = 78,
+		.accel_max_scale = 32000 << 16,
+		.temp_scale = 100,
+		.int_clk = 2000,
+		.max_dec = 1999,
+		.sync = adis16475_sync_mode,
+		/* pulse sync not supported */
+		.num_sync = ARRAY_SIZE(adis16475_sync_mode) - 1,
+		.has_burst32 = true,
+		.adis_data = ADIS16475_DATA(16505, &adis1650x_timeouts),
+	},
+	[ADIS16505_3] = {
+		.name = "adis16505-3",
+		.num_channels = ARRAY_SIZE(adis16475_channels),
+		.channels = adis16475_channels,
+		.gyro_max_val = 1,
+		.gyro_max_scale = IIO_RAD_TO_DEGREE(10 << 16),
+		.accel_max_val = 78,
+		.accel_max_scale = 32000 << 16,
+		.temp_scale = 100,
+		.int_clk = 2000,
+		.max_dec = 1999,
+		.sync = adis16475_sync_mode,
+		/* pulse sync not supported */
+		.num_sync = ARRAY_SIZE(adis16475_sync_mode) - 1,
+		.has_burst32 = true,
+		.adis_data = ADIS16475_DATA(16505, &adis1650x_timeouts),
+	},
+	[ADIS16507_1] = {
+		.name = "adis16507-1",
+		.num_channels = ARRAY_SIZE(adis16475_channels),
+		.channels = adis16475_channels,
+		.gyro_max_val = 1,
+		.gyro_max_scale = IIO_RAD_TO_DEGREE(160 << 16),
+		.accel_max_val = 392,
+		.accel_max_scale = 32000 << 16,
+		.temp_scale = 100,
+		.int_clk = 2000,
+		.max_dec = 1999,
+		.sync = adis16475_sync_mode,
+		/* pulse sync not supported */
+		.num_sync = ARRAY_SIZE(adis16475_sync_mode) - 1,
+		.has_burst32 = true,
+		.adis_data = ADIS16475_DATA(16507, &adis1650x_timeouts),
+	},
+	[ADIS16507_2] = {
+		.name = "adis16507-2",
+		.num_channels = ARRAY_SIZE(adis16475_channels),
+		.channels = adis16475_channels,
+		.gyro_max_val = 1,
+		.gyro_max_scale = IIO_RAD_TO_DEGREE(40 << 16),
+		.accel_max_val = 392,
+		.accel_max_scale = 32000 << 16,
+		.temp_scale = 100,
+		.int_clk = 2000,
+		.max_dec = 1999,
+		.sync = adis16475_sync_mode,
+		/* pulse sync not supported */
+		.num_sync = ARRAY_SIZE(adis16475_sync_mode) - 1,
+		.has_burst32 = true,
+		.adis_data = ADIS16475_DATA(16507, &adis1650x_timeouts),
+	},
+	[ADIS16507_3] = {
+		.name = "adis16507-3",
+		.num_channels = ARRAY_SIZE(adis16475_channels),
+		.channels = adis16475_channels,
+		.gyro_max_val = 1,
+		.gyro_max_scale = IIO_RAD_TO_DEGREE(10 << 16),
+		.accel_max_val = 392,
+		.accel_max_scale = 32000 << 16,
+		.temp_scale = 100,
+		.int_clk = 2000,
+		.max_dec = 1999,
+		.sync = adis16475_sync_mode,
+		/* pulse sync not supported */
+		.num_sync = ARRAY_SIZE(adis16475_sync_mode) - 1,
+		.has_burst32 = true,
+		.adis_data = ADIS16475_DATA(16507, &adis1650x_timeouts),
+	},
+};
+
+static const struct iio_info adis16475_info = {
+	.read_raw = &adis16475_read_raw,
+	.write_raw = &adis16475_write_raw,
+	.update_scan_mode = adis_update_scan_mode,
+	.debugfs_reg_access = adis_debugfs_reg_access,
+};
+
+static struct adis_burst adis16475_burst = {
+	.en = true,
+	.reg_cmd = ADIS16475_REG_GLOB_CMD,
+	/*
+	 * adis_update_scan_mode_burst() sets the burst length in respect with
+	 * the number of channels and allocates 16 bits for each. However,
+	 * adis1647x devices also need space for DIAG_STAT, DATA_CNTR or
+	 * TIME_STAMP (depending on the clock mode but for us these bytes are
+	 * don't care...) and CRC.
+	 */
+	.extra_len = 3 * sizeof(u16),
+	.burst_max_len = ADIS16475_BURST32_MAX_DATA,
+};
+
+static bool adis16475_validate_crc(const u8 *buffer, u16 crc,
+				   const bool burst32)
+{
+	int i;
+	/* extra 6 elements for low gyro and accel */
+	const u16 sz = burst32 ? ADIS16475_BURST32_MAX_DATA :
+		ADIS16475_BURST_MAX_DATA;
+
+	for (i = 0; i < sz - 2; i++)
+		crc -= buffer[i];
+
+	return crc == 0;
+}
+
+static void adis16475_burst32_check(struct adis16475 *st)
+{
+	int ret;
+	struct adis *adis = &st->adis;
+
+	if (!st->info->has_burst32)
+		return;
+
+	if (st->lsb_flag && !st->burst32) {
+		const u16 en = ADIS16500_BURST32(1);
+
+		ret = __adis_update_bits(&st->adis, ADIS16475_REG_MSG_CTRL,
+					 ADIS16500_BURST32_MASK, en);
+		if (ret)
+			return;
+
+		st->burst32 = true;
+
+		/*
+		 * In 32-bit mode we need extra 2 bytes for all gyro
+		 * and accel channels.
+		 */
+		adis->burst_extra_len = 6 * sizeof(u16);
+		adis->xfer[1].len += 6 * sizeof(u16);
+		dev_dbg(&adis->spi->dev, "Enable burst32 mode, xfer:%d",
+			adis->xfer[1].len);
+
+	} else if (!st->lsb_flag && st->burst32) {
+		const u16 en = ADIS16500_BURST32(0);
+
+		ret = __adis_update_bits(&st->adis, ADIS16475_REG_MSG_CTRL,
+					 ADIS16500_BURST32_MASK, en);
+		if (ret)
+			return;
+
+		st->burst32 = false;
+
+		/* Remove the extra bits */
+		adis->burst_extra_len = 0;
+		adis->xfer[1].len -= 6 * sizeof(u16);
+		dev_dbg(&adis->spi->dev, "Disable burst32 mode, xfer:%d\n",
+			adis->xfer[1].len);
+	}
+}
+
+static irqreturn_t adis16475_trigger_handler(int irq, void *p)
+{
+	struct iio_poll_func *pf = p;
+	struct iio_dev *indio_dev = pf->indio_dev;
+	struct adis16475 *st = iio_priv(indio_dev);
+	struct adis *adis = &st->adis;
+	int ret, bit, i = 0;
+	__be16 data[ADIS16475_MAX_SCAN_DATA], *buffer;
+	u16 crc;
+	bool valid;
+	/* offset until the first element after gyro and accel */
+	const u8 offset = st->burst32 ? 13 : 7;
+	const u32 cached_spi_speed_hz = adis->spi->max_speed_hz;
+
+	adis->spi->max_speed_hz = ADIS16475_BURST_MAX_SPEED;
+
+	ret = spi_sync(adis->spi, &adis->msg);
+	if (ret)
+		return ret;
+
+	adis->spi->max_speed_hz = cached_spi_speed_hz;
+	buffer = adis->buffer;
+
+	crc = be16_to_cpu(buffer[offset + 2]);
+	valid = adis16475_validate_crc(adis->buffer, crc, st->burst32);
+	if (!valid) {
+		dev_err(&adis->spi->dev, "Invalid crc\n");
+		goto check_burst32;
+	}
+
+	for_each_set_bit(bit, indio_dev->active_scan_mask,
+			 indio_dev->masklength) {
+		/*
+		 * When burst mode is used, system flags is the first data
+		 * channel in the sequence, but the scan index is 7.
+		 */
+		switch (bit) {
+		case ADIS16475_SCAN_TEMP:
+			data[i++] = buffer[offset];
+			break;
+		case ADIS16475_SCAN_GYRO_X ... ADIS16475_SCAN_ACCEL_Z:
+			/*
+			 * The first 2 bytes on the received data are the
+			 * DIAG_STAT reg, hence the +1 offset here...
+			 */
+			if (st->burst32) {
+				/* upper 16 */
+				data[i++] = buffer[bit * 2 + 2];
+				/* lower 16 */
+				data[i++] = buffer[bit * 2 + 1];
+			} else {
+				data[i++] = buffer[bit + 1];
+				/*
+				 * Don't bother in doing the manual read if the
+				 * device supports burst32. burst32 will be
+				 * enabled in the next call to
+				 * adis16475_burst32_check()...
+				 */
+				if (st->lsb_flag && !st->info->has_burst32) {
+					u16 val = 0;
+					const u32 reg = ADIS16475_REG_X_GYRO_L +
+						bit * 4;
+
+					adis_read_reg_16(adis, reg, &val);
+					data[i++] = cpu_to_be16(val);
+				} else {
+					/* lower not used */
+					data[i++] = 0;
+				}
+			}
+			break;
+		}
+	}
+
+	iio_push_to_buffers_with_timestamp(indio_dev, data, pf->timestamp);
+check_burst32:
+	/*
+	 * We only check the burst mode at the end of the current capture since
+	 * it takes a full data ready cycle for the device to update the burst
+	 * array.
+	 */
+	adis16475_burst32_check(st);
+	iio_trigger_notify_done(indio_dev->trig);
+
+	return IRQ_HANDLED;
+}
+
+static void adis16475_disable_clk(void *data)
+{
+	clk_disable_unprepare((struct clk *)data);
+}
+
+static int adis16475_config_sync_mode(struct adis16475 *st)
+{
+	int ret;
+	struct device *dev = &st->adis.spi->dev;
+	const struct adis16475_sync *sync;
+	u32 sync_mode;
+
+	/* default to internal clk */
+	st->clk_freq = st->info->int_clk * 1000;
+
+	ret = device_property_read_u32(dev, "adi,sync-mode", &sync_mode);
+	if (ret)
+		return 0;
+
+	if (sync_mode >= st->info->num_sync) {
+		dev_err(dev, "Invalid sync mode: %u for %s\n", sync_mode,
+			st->info->name);
+		return -EINVAL;
+	}
+
+	sync = &st->info->sync[sync_mode];
+
+	/* All the other modes require external input signal */
+	if (sync->sync_mode != ADIS16475_SYNC_OUTPUT) {
+		struct clk *clk = devm_clk_get(dev, NULL);
+
+		if (IS_ERR(clk))
+			return PTR_ERR(clk);
+
+		ret = clk_prepare_enable(clk);
+		if (ret)
+			return ret;
+
+		ret = devm_add_action_or_reset(dev, adis16475_disable_clk, clk);
+		if (ret)
+			return ret;
+
+		st->clk_freq = clk_get_rate(clk);
+		if (st->clk_freq < sync->min_rate ||
+		    st->clk_freq > sync->max_rate) {
+			dev_err(dev,
+				"Clk rate:%u not in a valid range:[%u %u]\n",
+				st->clk_freq, sync->min_rate, sync->max_rate);
+			return -EINVAL;
+		}
+
+		if (sync->sync_mode == ADIS16475_SYNC_SCALED) {
+			u16 up_scale;
+			u32 scaled_out_freq = 0;
+			/*
+			 * If we are in scaled mode, we must have an up_scale.
+			 * In scaled mode the allowable input clock range is
+			 * 1 Hz to 128 Hz, and the allowable output range is
+			 * 1900 to 2100 Hz. Hence, a scale must be given to
+			 * get the allowable output.
+			 */
+			ret = device_property_read_u32(dev,
+						       "adi,scaled-output-hz",
+						       &scaled_out_freq);
+			if (ret) {
+				dev_err(dev, "adi,scaled-output-hz must be given when in scaled sync mode");
+				return -EINVAL;
+			} else if (scaled_out_freq < 1900 ||
+				   scaled_out_freq > 2100) {
+				dev_err(dev, "Invalid value: %u for adi,scaled-output-hz",
+					scaled_out_freq);
+				return -EINVAL;
+			}
+
+			up_scale = DIV_ROUND_CLOSEST(scaled_out_freq,
+						     st->clk_freq);
+
+			ret = __adis_write_reg_16(&st->adis,
+						  ADIS16475_REG_UP_SCALE,
+						  up_scale);
+			if (ret)
+				return ret;
+
+			st->clk_freq = scaled_out_freq;
+		}
+
+		st->clk_freq *= 1000;
+	}
+	/*
+	 * Keep in mind that the mask for the clk modes in adis1650*
+	 * chips is different (1100 instead of 11100). However, we
+	 * are not configuring BIT(4) in these chips and the default
+	 * value is 0, so we are fine in doing the below operations.
+	 * I'm keeping this for simplicity and avoiding extra variables
+	 * in chip_info.
+	 */
+	ret = __adis_update_bits(&st->adis, ADIS16475_REG_MSG_CTRL,
+				 ADIS16475_SYNC_MODE_MASK, sync->sync_mode);
+	if (ret)
+		return ret;
+
+	usleep_range(250, 260);
+
+	return 0;
+}
+
+static int adis16475_config_irq_pin(struct adis16475 *st)
+{
+	int ret;
+	struct irq_data *desc;
+	u32 irq_type;
+	u16 val = 0;
+	u8 polarity;
+	struct spi_device *spi = st->adis.spi;
+
+	desc = irq_get_irq_data(spi->irq);
+	if (!desc) {
+		dev_err(&spi->dev, "Could not find IRQ %d\n", spi->irq);
+		return -EINVAL;
+	}
+	/*
+	 * It is possible to configure the data ready polarity. Furthermore, we
+	 * need to update the adis struct if we want data ready as active low.
+	 */
+	irq_type = irqd_get_trigger_type(desc);
+	if (irq_type == IRQ_TYPE_EDGE_RISING) {
+		polarity = 1;
+		st->adis.irq_flag = IRQF_TRIGGER_RISING;
+	} else if (irq_type == IRQ_TYPE_EDGE_FALLING) {
+		polarity = 0;
+		st->adis.irq_flag = IRQF_TRIGGER_FALLING;
+	} else {
+		dev_err(&spi->dev, "Invalid interrupt type 0x%x specified\n",
+			irq_type);
+		return -EINVAL;
+	}
+
+	val = ADIS16475_MSG_CTRL_DR_POL(polarity);
+	ret = __adis_update_bits(&st->adis, ADIS16475_REG_MSG_CTRL,
+				 ADIS16475_MSG_CTRL_DR_POL_MASK, val);
+	if (ret)
+		return ret;
+	/*
+	 * There is a delay writing to any bits written to the MSC_CTRL
+	 * register. It should not be bigger than 200us, so 250 should be more
+	 * than enough!
+	 */
+	usleep_range(250, 260);
+
+	return 0;
+}
+
+static const struct of_device_id adis16475_of_match[] = {
+	{ .compatible = "adi,adis16470",
+		.data = &adis16475_chip_info[ADIS16470] },
+	{ .compatible = "adi,adis16475-1",
+		.data = &adis16475_chip_info[ADIS16475_1] },
+	{ .compatible = "adi,adis16475-2",
+		.data = &adis16475_chip_info[ADIS16475_2] },
+	{ .compatible = "adi,adis16475-3",
+		.data = &adis16475_chip_info[ADIS16475_3] },
+	{ .compatible = "adi,adis16477-1",
+		.data = &adis16475_chip_info[ADIS16477_1] },
+	{ .compatible = "adi,adis16477-2",
+		.data = &adis16475_chip_info[ADIS16477_2] },
+	{ .compatible = "adi,adis16477-3",
+		.data = &adis16475_chip_info[ADIS16477_3] },
+	{ .compatible = "adi,adis16465-1",
+		.data = &adis16475_chip_info[ADIS16465_1] },
+	{ .compatible = "adi,adis16465-2",
+		.data = &adis16475_chip_info[ADIS16465_2] },
+	{ .compatible = "adi,adis16465-3",
+		.data = &adis16475_chip_info[ADIS16465_3] },
+	{ .compatible = "adi,adis16467-1",
+		.data = &adis16475_chip_info[ADIS16467_1] },
+	{ .compatible = "adi,adis16467-2",
+		.data = &adis16475_chip_info[ADIS16467_2] },
+	{ .compatible = "adi,adis16467-3",
+		.data = &adis16475_chip_info[ADIS16467_3] },
+	{ .compatible = "adi,adis16500",
+		.data = &adis16475_chip_info[ADIS16500] },
+	{ .compatible = "adi,adis16505-1",
+		.data = &adis16475_chip_info[ADIS16505_1] },
+	{ .compatible = "adi,adis16505-2",
+		.data = &adis16475_chip_info[ADIS16505_2] },
+	{ .compatible = "adi,adis16505-3",
+		.data = &adis16475_chip_info[ADIS16505_3] },
+	{ .compatible = "adi,adis16507-1",
+		.data = &adis16475_chip_info[ADIS16507_1] },
+	{ .compatible = "adi,adis16507-2",
+		.data = &adis16475_chip_info[ADIS16507_2] },
+	{ .compatible = "adi,adis16507-3",
+		.data = &adis16475_chip_info[ADIS16507_3] },
+	{ },
+};
+MODULE_DEVICE_TABLE(of, adis16475_of_match);
+
+static int adis16475_probe(struct spi_device *spi)
+{
+	struct iio_dev *indio_dev;
+	struct adis16475 *st;
+	int ret;
+
+	indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*st));
+	if (!indio_dev)
+		return -ENOMEM;
+
+	st = iio_priv(indio_dev);
+	spi_set_drvdata(spi, indio_dev);
+	st->adis.burst = &adis16475_burst;
+
+	st->info = device_get_match_data(&spi->dev);
+	if (!st->info)
+		return -EINVAL;
+
+	ret = adis_init(&st->adis, indio_dev, spi, &st->info->adis_data);
+	if (ret)
+		return ret;
+
+	indio_dev->dev.parent = &spi->dev;
+	indio_dev->name = st->info->name;
+	indio_dev->channels = st->info->channels;
+	indio_dev->num_channels = st->info->num_channels;
+	indio_dev->info = &adis16475_info;
+	indio_dev->modes = INDIO_DIRECT_MODE;
+
+	ret = __adis_initial_startup(&st->adis);
+	if (ret)
+		return ret;
+
+	ret = adis16475_config_irq_pin(st);
+	if (ret)
+		return ret;
+
+	ret = adis16475_config_sync_mode(st);
+	if (ret)
+		return ret;
+
+	ret = devm_adis_setup_buffer_and_trigger(&st->adis, indio_dev,
+						 adis16475_trigger_handler);
+	if (ret)
+		return ret;
+
+	adis16475_enable_irq(&st->adis, false);
+
+	ret = devm_iio_device_register(&spi->dev, indio_dev);
+	if (ret)
+		return ret;
+
+	adis16475_debugfs_init(indio_dev);
+
+	return 0;
+}
+
+static struct spi_driver adis16475_driver = {
+	.driver = {
+		.name = "adis16475",
+		.of_match_table = adis16475_of_match,
+	},
+	.probe = adis16475_probe,
+};
+module_spi_driver(adis16475_driver);
+
+MODULE_AUTHOR("Nuno Sa <nuno.sa@analog.com>");
+MODULE_DESCRIPTION("Analog Devices ADIS16475 IMU driver");
+MODULE_LICENSE("GPL");
-- 
2.17.1


^ permalink raw reply	[flat|nested] 24+ messages in thread

* [PATCH v5 6/6] dt-bindings: iio: Add adis16475 documentation
  2020-04-13  8:24 [PATCH v5 0/6] Support ADIS16475 and similar IMUs Nuno Sá
                   ` (4 preceding siblings ...)
  2020-04-13  8:24 ` [PATCH v5 5/6] iio: imu: Add support for adis16475 Nuno Sá
@ 2020-04-13  8:24 ` Nuno Sá
  2020-04-20 19:17   ` Rob Herring
  2020-04-13 16:27 ` [PATCH v5 0/6] Support ADIS16475 and similar IMUs Jonathan Cameron
  6 siblings, 1 reply; 24+ messages in thread
From: Nuno Sá @ 2020-04-13  8:24 UTC (permalink / raw)
  To: linux-iio, devicetree
  Cc: Jonathan Cameron, Hartmut Knaack, Lars-Peter Clausen,
	Peter Meerwald-Stadler, Rob Herring, Mark Rutland,
	Alexandru Ardelean, Michael Hennerich

Document the ADIS16475 device devicetree bindings

Signed-off-by: Nuno Sá <nuno.sa@analog.com>
---
Changes in v2:
 * Remove burst32 property;
 * Rename clk-mode to adi,sync-mode;
 * Remove clock-names;
 * Add conditionals to state that clocks is only needed depending on adi,sync-mode property.

Changes in v3:
 * Make use of 'allOf' in conditionals.

Changes in v4:
 * Nothing changed.

Changes in v5:
 * Nothing changed.

 .../bindings/iio/imu/adi,adis16475.yaml       | 137 ++++++++++++++++++
 MAINTAINERS                                   |   1 +
 2 files changed, 138 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/imu/adi,adis16475.yaml

diff --git a/Documentation/devicetree/bindings/iio/imu/adi,adis16475.yaml b/Documentation/devicetree/bindings/iio/imu/adi,adis16475.yaml
new file mode 100644
index 000000000000..98baecb4b98a
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/imu/adi,adis16475.yaml
@@ -0,0 +1,137 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/imu/adi,adis16475.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Analog Devices ADIS16475 and similar IMUs
+
+maintainers:
+  - Nuno Sá <nuno.sa@analog.com>
+
+description: |
+  Analog Devices ADIS16475 and similar IMUs
+  https://www.analog.com/media/en/technical-documentation/data-sheets/ADIS16475.pdf
+
+properties:
+  compatible:
+    enum:
+      - adi,adis16475-1
+      - adi,adis16475-2
+      - adi,adis16475-3
+      - adi,adis16477-1
+      - adi,adis16477-2
+      - adi,adis16477-3
+      - adi,adis16470
+      - adi,adis16465-1
+      - adi,adis16465-2
+      - adi,adis16465-3
+      - adi,adis16467-1
+      - adi,adis16467-2
+      - adi,adis16467-3
+      - adi,adis16500
+      - adi,adis16505-1
+      - adi,adis16505-2
+      - adi,adis16505-3
+      - adi,adis16507-1
+      - adi,adis16507-2
+      - adi,adis16507-3
+
+  reg:
+    maxItems: 1
+
+  spi-cpha: true
+
+  spi-cpol: true
+
+  spi-max-frequency:
+    maximum: 2000000
+
+  interrupts:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  reset-gpios:
+    description:
+      Must be the device tree identifier of the RESET pin. If specified,
+      it will be asserted during driver probe. As the line is active low,
+      it should be marked GPIO_ACTIVE_LOW.
+    maxItems: 1
+
+  adi,sync-mode:
+    description:
+      Configures the device SYNC pin. The following modes are supported
+      0 - output_sync
+      1 - direct_sync
+      2 - scaled_sync
+      3 - pulse_sync
+    allOf:
+      - $ref: /schemas/types.yaml#/definitions/uint32
+    minimum: 0
+    maximum: 3
+
+  adi,scaled-output-hz:
+    description:
+      This property must be present if the clock mode is scaled-sync through
+      clock-names property. In this mode, the input clock can have a range
+      of 1Hz to 128HZ which must be scaled to originate an allowable sample
+      rate. This property specifies that rate.
+    minimum: 1900
+    maximum: 2100
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - spi-cpha
+  - spi-cpol
+
+allOf:
+  - if:
+      properties:
+        compatible:
+          contains:
+            enum:
+              - adi,adis16500
+              - adi,adis16505-1
+              - adi,adis16505-2
+              - adi,adis16505-3
+              - adi,adis16507-1
+              - adi,adis16507-2
+              - adi,adis16507-3
+
+    then:
+      properties:
+        adi,sync-mode:
+          minimum: 0
+          maximum: 2
+
+  - if:
+      properties:
+        adi,sync-mode:
+          enum: [1, 2, 3]
+
+    then:
+      dependencies:
+        adi,sync-mode: [ clocks ]
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    spi {
+            #address-cells = <1>;
+            #size-cells = <0>;
+
+            adis16475: adis16475-3@0 {
+                    compatible = "adi,adis16475-3";
+                    reg = <0>;
+                    spi-cpha;
+                    spi-cpol;
+                    spi-max-frequency = <2000000>;
+                    interrupts = <4 IRQ_TYPE_EDGE_RISING>;
+                    interrupt-parent = <&gpio>;
+            };
+    };
+...
diff --git a/MAINTAINERS b/MAINTAINERS
index a2ff8322c184..0828302accd8 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1015,6 +1015,7 @@ L:	linux-iio@vger.kernel.org
 W:	http://ez.analog.com/community/linux-device-drivers
 S:	Supported
 F:	drivers/iio/imu/adis16475.c
+F:	Documentation/devicetree/bindings/iio/imu/adi,adis16475.yaml
 
 ANALOG DEVICES INC ADM1177 DRIVER
 M:	Beniamin Bia <beniamin.bia@analog.com>
-- 
2.17.1


^ permalink raw reply	[flat|nested] 24+ messages in thread

* Re: [PATCH v5 0/6] Support ADIS16475 and similar IMUs
  2020-04-13  8:24 [PATCH v5 0/6] Support ADIS16475 and similar IMUs Nuno Sá
                   ` (5 preceding siblings ...)
  2020-04-13  8:24 ` [PATCH v5 6/6] dt-bindings: iio: Add adis16475 documentation Nuno Sá
@ 2020-04-13 16:27 ` Jonathan Cameron
  2020-04-25 15:18   ` Jonathan Cameron
  6 siblings, 1 reply; 24+ messages in thread
From: Jonathan Cameron @ 2020-04-13 16:27 UTC (permalink / raw)
  To: Nuno Sá
  Cc: linux-iio, devicetree, Hartmut Knaack, Lars-Peter Clausen,
	Peter Meerwald-Stadler, Rob Herring, Mark Rutland,
	Alexandru Ardelean, Michael Hennerich

On Mon, 13 Apr 2020 10:24:39 +0200
Nuno Sá <nuno.sa@analog.com> wrote:

> This series adds support for the adis16475 and similar IMUs. This driver
> will be the first user of some changes on the adis library. Hence, the
> first three patches are related to the library:
>  * Add anaged device functions for registering triggers with the library;
>  * Updates the way `irq_mask` is passed to `request_irq()`;
>  * It adds an update_bits() like API.
> 
> A new patch was introduced (iio: adis: Add burst_max_len variable) in
> order to make burst32 configuration at runtime.

Series looks good to me, but I'd like to allow a bit of time for DT
review + anyone else who wants to take another look.

Thanks,

Jonathan

> 
> Nuno Sá (6):
>   iio: imu: adis: Add Managed device functions
>   iio: imu: adis: Add irq mask variable
>   iio: adis: Add adis_update_bits() APIs
>   iio: adis: Support different burst sizes
>   iio: imu: Add support for adis16475
>   dt-bindings: iio: Add adis16475 documentation
> 
>  .../bindings/iio/imu/adi,adis16475.yaml       |  137 ++
>  MAINTAINERS                                   |    8 +
>  drivers/iio/imu/Kconfig                       |   13 +
>  drivers/iio/imu/Makefile                      |    1 +
>  drivers/iio/imu/adis.c                        |   25 +
>  drivers/iio/imu/adis16400.c                   |    2 +-
>  drivers/iio/imu/adis16475.c                   | 1336 +++++++++++++++++
>  drivers/iio/imu/adis_buffer.c                 |   58 +-
>  drivers/iio/imu/adis_trigger.c                |   72 +-
>  include/linux/iio/imu/adis.h                  |   87 +-
>  10 files changed, 1728 insertions(+), 11 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/iio/imu/adi,adis16475.yaml
>  create mode 100644 drivers/iio/imu/adis16475.c
> 


^ permalink raw reply	[flat|nested] 24+ messages in thread

* Re: [PATCH v5 6/6] dt-bindings: iio: Add adis16475 documentation
  2020-04-13  8:24 ` [PATCH v5 6/6] dt-bindings: iio: Add adis16475 documentation Nuno Sá
@ 2020-04-20 19:17   ` Rob Herring
  0 siblings, 0 replies; 24+ messages in thread
From: Rob Herring @ 2020-04-20 19:17 UTC (permalink / raw)
  To: Nuno Sá
  Cc: linux-iio, devicetree, Jonathan Cameron, Hartmut Knaack,
	Lars-Peter Clausen, Peter Meerwald-Stadler, Mark Rutland,
	Alexandru Ardelean, Michael Hennerich

On Mon, 13 Apr 2020 10:24:45 +0200, =?UTF-8?q?Nuno=20S=C3=A1?= wrote:
> Document the ADIS16475 device devicetree bindings
> 
> Signed-off-by: Nuno Sá <nuno.sa@analog.com>
> ---
> Changes in v2:
>  * Remove burst32 property;
>  * Rename clk-mode to adi,sync-mode;
>  * Remove clock-names;
>  * Add conditionals to state that clocks is only needed depending on adi,sync-mode property.
> 
> Changes in v3:
>  * Make use of 'allOf' in conditionals.
> 
> Changes in v4:
>  * Nothing changed.
> 
> Changes in v5:
>  * Nothing changed.
> 
>  .../bindings/iio/imu/adi,adis16475.yaml       | 137 ++++++++++++++++++
>  MAINTAINERS                                   |   1 +
>  2 files changed, 138 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/imu/adi,adis16475.yaml
> 

Reviewed-by: Rob Herring <robh@kernel.org>

^ permalink raw reply	[flat|nested] 24+ messages in thread

* Re: [PATCH v5 0/6] Support ADIS16475 and similar IMUs
  2020-04-13 16:27 ` [PATCH v5 0/6] Support ADIS16475 and similar IMUs Jonathan Cameron
@ 2020-04-25 15:18   ` Jonathan Cameron
  0 siblings, 0 replies; 24+ messages in thread
From: Jonathan Cameron @ 2020-04-25 15:18 UTC (permalink / raw)
  To: Nuno Sá
  Cc: linux-iio, devicetree, Hartmut Knaack, Lars-Peter Clausen,
	Peter Meerwald-Stadler, Rob Herring, Mark Rutland,
	Alexandru Ardelean, Michael Hennerich

On Mon, 13 Apr 2020 17:27:22 +0100
Jonathan Cameron <jic23@kernel.org> wrote:

> On Mon, 13 Apr 2020 10:24:39 +0200
> Nuno Sá <nuno.sa@analog.com> wrote:
> 
> > This series adds support for the adis16475 and similar IMUs. This driver
> > will be the first user of some changes on the adis library. Hence, the
> > first three patches are related to the library:
> >  * Add anaged device functions for registering triggers with the library;
> >  * Updates the way `irq_mask` is passed to `request_irq()`;
> >  * It adds an update_bits() like API.
> > 
> > A new patch was introduced (iio: adis: Add burst_max_len variable) in
> > order to make burst32 configuration at runtime.  
> 
> Series looks good to me, but I'd like to allow a bit of time for DT
> review + anyone else who wants to take another look.

Applied to the togreg branch of iio.git and pushed out as testing for
the autobuilders to play with it.

Thanks,

Jonathan

> 
> Thanks,
> 
> Jonathan
> 
> > 
> > Nuno Sá (6):
> >   iio: imu: adis: Add Managed device functions
> >   iio: imu: adis: Add irq mask variable
> >   iio: adis: Add adis_update_bits() APIs
> >   iio: adis: Support different burst sizes
> >   iio: imu: Add support for adis16475
> >   dt-bindings: iio: Add adis16475 documentation
> > 
> >  .../bindings/iio/imu/adi,adis16475.yaml       |  137 ++
> >  MAINTAINERS                                   |    8 +
> >  drivers/iio/imu/Kconfig                       |   13 +
> >  drivers/iio/imu/Makefile                      |    1 +
> >  drivers/iio/imu/adis.c                        |   25 +
> >  drivers/iio/imu/adis16400.c                   |    2 +-
> >  drivers/iio/imu/adis16475.c                   | 1336 +++++++++++++++++
> >  drivers/iio/imu/adis_buffer.c                 |   58 +-
> >  drivers/iio/imu/adis_trigger.c                |   72 +-
> >  include/linux/iio/imu/adis.h                  |   87 +-
> >  10 files changed, 1728 insertions(+), 11 deletions(-)
> >  create mode 100644 Documentation/devicetree/bindings/iio/imu/adi,adis16475.yaml
> >  create mode 100644 drivers/iio/imu/adis16475.c
> >   
> 


^ permalink raw reply	[flat|nested] 24+ messages in thread

* Re: [PATCH v5 5/6] iio: imu: Add support for adis16475
  2020-04-13  8:24 ` [PATCH v5 5/6] iio: imu: Add support for adis16475 Nuno Sá
@ 2020-04-27 18:06   ` Lars-Peter Clausen
  2020-05-02 17:40     ` Jonathan Cameron
  0 siblings, 1 reply; 24+ messages in thread
From: Lars-Peter Clausen @ 2020-04-27 18:06 UTC (permalink / raw)
  To: Nuno Sá, linux-iio, devicetree
  Cc: Jonathan Cameron, Hartmut Knaack, Peter Meerwald-Stadler,
	Rob Herring, Mark Rutland, Alexandru Ardelean, Michael Hennerich

On 4/13/20 10:24 AM, Nuno Sá wrote:
> [...]
> +static irqreturn_t adis16475_trigger_handler(int irq, void *p)
> +{
> [...]
> +	__be16 data[ADIS16475_MAX_SCAN_DATA], *buffer;
> [...]
> +
> +	iio_push_to_buffers_with_timestamp(indio_dev, data, pf->timestamp);

If the timestamp is enabled the IIO core might insert padding between 
the data channels and the timestamp. If that happens this will disclose 
kernel stack memory to userspace.

This needs either a memset(data, 0x00, sizeof(data)) or maybe put data 
into the state struct and kzalloc it.

- Lars


^ permalink raw reply	[flat|nested] 24+ messages in thread

* Re: [PATCH v5 5/6] iio: imu: Add support for adis16475
  2020-04-27 18:06   ` Lars-Peter Clausen
@ 2020-05-02 17:40     ` Jonathan Cameron
  2020-05-02 18:01       ` Lars-Peter Clausen
  0 siblings, 1 reply; 24+ messages in thread
From: Jonathan Cameron @ 2020-05-02 17:40 UTC (permalink / raw)
  To: Lars-Peter Clausen
  Cc: Nuno Sá,
	linux-iio, devicetree, Hartmut Knaack, Peter Meerwald-Stadler,
	Rob Herring, Mark Rutland, Alexandru Ardelean, Michael Hennerich

On Mon, 27 Apr 2020 20:06:07 +0200
Lars-Peter Clausen <lars@metafoo.de> wrote:

> On 4/13/20 10:24 AM, Nuno Sá wrote:
> > [...]
> > +static irqreturn_t adis16475_trigger_handler(int irq, void *p)
> > +{
> > [...]
> > +	__be16 data[ADIS16475_MAX_SCAN_DATA], *buffer;
> > [...]
> > +
> > +	iio_push_to_buffers_with_timestamp(indio_dev, data, pf->timestamp);  
> 
> If the timestamp is enabled the IIO core might insert padding between 
> the data channels and the timestamp. If that happens this will disclose 
> kernel stack memory to userspace.
> 
> This needs either a memset(data, 0x00, sizeof(data)) or maybe put data 
> into the state struct and kzalloc it.

Good spot. Could simply do __be16 data[ADI..] = {0}; rather than explicit
memset, but some form of zeroization is needed.

I've fixed up the applied patch with the above approach.

Thanks,

Jonathan

> 
> - Lars
> 


^ permalink raw reply	[flat|nested] 24+ messages in thread

* Re: [PATCH v5 5/6] iio: imu: Add support for adis16475
  2020-05-02 17:40     ` Jonathan Cameron
@ 2020-05-02 18:01       ` Lars-Peter Clausen
  2020-05-02 19:52         ` Nuno Sá
  0 siblings, 1 reply; 24+ messages in thread
From: Lars-Peter Clausen @ 2020-05-02 18:01 UTC (permalink / raw)
  To: Jonathan Cameron
  Cc: Nuno Sá,
	linux-iio, devicetree, Hartmut Knaack, Peter Meerwald-Stadler,
	Rob Herring, Mark Rutland, Alexandru Ardelean, Michael Hennerich

On 5/2/20 7:40 PM, Jonathan Cameron wrote:
> On Mon, 27 Apr 2020 20:06:07 +0200
> Lars-Peter Clausen <lars@metafoo.de> wrote:
>
>> On 4/13/20 10:24 AM, Nuno Sá wrote:
>>> [...]
>>> +static irqreturn_t adis16475_trigger_handler(int irq, void *p)
>>> +{
>>> [...]
>>> +	__be16 data[ADIS16475_MAX_SCAN_DATA], *buffer;
>>> [...]
>>> +
>>> +	iio_push_to_buffers_with_timestamp(indio_dev, data, pf->timestamp);
>> If the timestamp is enabled the IIO core might insert padding between
>> the data channels and the timestamp. If that happens this will disclose
>> kernel stack memory to userspace.
>>
>> This needs either a memset(data, 0x00, sizeof(data)) or maybe put data
>> into the state struct and kzalloc it.
> Good spot. Could simply do __be16 data[ADI..] = {0}; rather than explicit
> memset, but some form of zeroization is needed.
>
> I've fixed up the applied patch with the above approach.
There is actually another issue. The stack data is not necessarily 
aligned to 64 bit, which causes issues if we try to put the 64-bit 
timestamp in it. I think data should really be in the state struct.

^ permalink raw reply	[flat|nested] 24+ messages in thread

* Re: [PATCH v5 5/6] iio: imu: Add support for adis16475
  2020-05-02 18:01       ` Lars-Peter Clausen
@ 2020-05-02 19:52         ` Nuno Sá
  2020-05-03  8:47           ` Jonathan Cameron
  0 siblings, 1 reply; 24+ messages in thread
From: Nuno Sá @ 2020-05-02 19:52 UTC (permalink / raw)
  To: Lars-Peter Clausen, Jonathan Cameron
  Cc: Nuno Sá,
	linux-iio, devicetree, Hartmut Knaack, Peter Meerwald-Stadler,
	Rob Herring, Mark Rutland, Alexandru Ardelean, Michael Hennerich

On Sat, 2020-05-02 at 20:01 +0200, Lars-Peter Clausen wrote:
> On 5/2/20 7:40 PM, Jonathan Cameron wrote:
> > On Mon, 27 Apr 2020 20:06:07 +0200
> > Lars-Peter Clausen <lars@metafoo.de> wrote:
> > 
> > > On 4/13/20 10:24 AM, Nuno Sá wrote:
> > > > [...]
> > > > +static irqreturn_t adis16475_trigger_handler(int irq, void *p)
> > > > +{
> > > > [...]
> > > > +	__be16 data[ADIS16475_MAX_SCAN_DATA], *buffer;
> > > > [...]
> > > > +
> > > > +	iio_push_to_buffers_with_timestamp(indio_dev, data, pf-
> > > > >timestamp);
> > > If the timestamp is enabled the IIO core might insert padding
> > > between
> > > the data channels and the timestamp. If that happens this will
> > > disclose
> > > kernel stack memory to userspace.
> > > 
> > > This needs either a memset(data, 0x00, sizeof(data)) or maybe put
> > > data
> > > into the state struct and kzalloc it.
> > Good spot. Could simply do __be16 data[ADI..] = {0}; rather than
> > explicit
> > memset, but some form of zeroization is needed.
> > 
> > I've fixed up the applied patch with the above approach.
> There is actually another issue. The stack data is not necessarily 
> aligned to 64 bit, which causes issues if we try to put the 64-bit 

Oh, this is actually more problematic. Yes, since we have an array of
u16, that is not guaranteed to be 64bit aligned. Doing a quick search
of `iio_push_to_buffers_with_timestamp()` users and I could quickly
find 4/5 drivers with the same problem. I guess the API should clearly
state that `data` needs to be __at least__ 64 bits aligned (maybe a
future patch). Or we could even check the address and guarantee that it
is properly aligned before continuing (though Im guessing this will
break a lot of users...)
> timestamp in it. I think data should really be in the state struct.

Yes, with a proper __aligned(8) attribute... Or couldn't we just use
__aligned(8) on the stack variable?

- Nuno Sá



^ permalink raw reply	[flat|nested] 24+ messages in thread

* Re: [PATCH v5 5/6] iio: imu: Add support for adis16475
  2020-05-02 19:52         ` Nuno Sá
@ 2020-05-03  8:47           ` Jonathan Cameron
  2020-05-03  9:07             ` Lars-Peter Clausen
  0 siblings, 1 reply; 24+ messages in thread
From: Jonathan Cameron @ 2020-05-03  8:47 UTC (permalink / raw)
  To: Nuno Sá
  Cc: Lars-Peter Clausen, Nuno Sá,
	linux-iio, devicetree, Hartmut Knaack, Peter Meerwald-Stadler,
	Rob Herring, Mark Rutland, Alexandru Ardelean, Michael Hennerich

On Sat, 02 May 2020 21:52:18 +0200
Nuno Sá <noname.nuno@gmail.com> wrote:

> On Sat, 2020-05-02 at 20:01 +0200, Lars-Peter Clausen wrote:
> > On 5/2/20 7:40 PM, Jonathan Cameron wrote:  
> > > On Mon, 27 Apr 2020 20:06:07 +0200
> > > Lars-Peter Clausen <lars@metafoo.de> wrote:
> > >   
> > > > On 4/13/20 10:24 AM, Nuno Sá wrote:  
> > > > > [...]
> > > > > +static irqreturn_t adis16475_trigger_handler(int irq, void *p)
> > > > > +{
> > > > > [...]
> > > > > +	__be16 data[ADIS16475_MAX_SCAN_DATA], *buffer;
> > > > > [...]
> > > > > +
> > > > > +	iio_push_to_buffers_with_timestamp(indio_dev, data, pf-  
> > > > > >timestamp);  
> > > > If the timestamp is enabled the IIO core might insert padding
> > > > between
> > > > the data channels and the timestamp. If that happens this will
> > > > disclose
> > > > kernel stack memory to userspace.
> > > > 
> > > > This needs either a memset(data, 0x00, sizeof(data)) or maybe put
> > > > data
> > > > into the state struct and kzalloc it.  
> > > Good spot. Could simply do __be16 data[ADI..] = {0}; rather than
> > > explicit
> > > memset, but some form of zeroization is needed.
> > > 
> > > I've fixed up the applied patch with the above approach.  
> > There is actually another issue. The stack data is not necessarily 
> > aligned to 64 bit, which causes issues if we try to put the 64-bit   
> 
> Oh, this is actually more problematic. Yes, since we have an array of
> u16, that is not guaranteed to be 64bit aligned. Doing a quick search
> of `iio_push_to_buffers_with_timestamp()` users and I could quickly
> find 4/5 drivers with the same problem. I guess the API should clearly
> state that `data` needs to be __at least__ 64 bits aligned (maybe a
> future patch). Or we could even check the address and guarantee that it
> is properly aligned before continuing (though Im guessing this will
> break a lot of users...)
> > timestamp in it. I think data should really be in the state struct.  
> 
> Yes, with a proper __aligned(8) attribute... Or couldn't we just use
> __aligned(8) on the stack variable?

Forcing alignment on the stack isn't terribly reliable, which is why
we never do that for dma safe buffers.

Probably better to just move it to the state structure. 
I'll fix it up to do that. Please sanity check what will shortly
be in the testing branch.

The moment Lars mentioned this I groaned. As you've noted a few other
drivers have the same problem + the ABI doesn't clearly state
or check this. 

We should certainly fix all the drivers that suffer this problem
first then we can think about adding a runtime check.

Jonathan
> 
> - Nuno Sá
> 
> 


^ permalink raw reply	[flat|nested] 24+ messages in thread

* Re: [PATCH v5 5/6] iio: imu: Add support for adis16475
  2020-05-03  8:47           ` Jonathan Cameron
@ 2020-05-03  9:07             ` Lars-Peter Clausen
  2020-05-03  9:12               ` Lars-Peter Clausen
  2020-05-03 11:07               ` Nuno Sá
  0 siblings, 2 replies; 24+ messages in thread
From: Lars-Peter Clausen @ 2020-05-03  9:07 UTC (permalink / raw)
  To: Jonathan Cameron, Nuno Sá
  Cc: Nuno Sá,
	linux-iio, devicetree, Hartmut Knaack, Peter Meerwald-Stadler,
	Rob Herring, Mark Rutland, Alexandru Ardelean, Michael Hennerich

On 5/3/20 10:47 AM, Jonathan Cameron wrote:
> On Sat, 02 May 2020 21:52:18 +0200
> Nuno Sá <noname.nuno@gmail.com> wrote:
>
>> On Sat, 2020-05-02 at 20:01 +0200, Lars-Peter Clausen wrote:
>>> On 5/2/20 7:40 PM, Jonathan Cameron wrote:
>>>> On Mon, 27 Apr 2020 20:06:07 +0200
>>>> Lars-Peter Clausen <lars@metafoo.de> wrote:
>>>>    
>>>>> On 4/13/20 10:24 AM, Nuno Sá wrote:
>>>>>> [...]
>>>>>> +static irqreturn_t adis16475_trigger_handler(int irq, void *p)
>>>>>> +{
>>>>>> [...]
>>>>>> +	__be16 data[ADIS16475_MAX_SCAN_DATA], *buffer;
>>>>>> [...]
>>>>>> +
>>>>>> +	iio_push_to_buffers_with_timestamp(indio_dev, data, pf-
>>>>>>> timestamp);
>>>>> If the timestamp is enabled the IIO core might insert padding
>>>>> between
>>>>> the data channels and the timestamp. If that happens this will
>>>>> disclose
>>>>> kernel stack memory to userspace.
>>>>>
>>>>> This needs either a memset(data, 0x00, sizeof(data)) or maybe put
>>>>> data
>>>>> into the state struct and kzalloc it.
>>>> Good spot. Could simply do __be16 data[ADI..] = {0}; rather than
>>>> explicit
>>>> memset, but some form of zeroization is needed.
>>>>
>>>> I've fixed up the applied patch with the above approach.
>>> There is actually another issue. The stack data is not necessarily
>>> aligned to 64 bit, which causes issues if we try to put the 64-bit
>> Oh, this is actually more problematic. Yes, since we have an array of
>> u16, that is not guaranteed to be 64bit aligned. Doing a quick search
>> of `iio_push_to_buffers_with_timestamp()` users and I could quickly
>> find 4/5 drivers with the same problem. I guess the API should clearly
>> state that `data` needs to be __at least__ 64 bits aligned (maybe a
>> future patch). Or we could even check the address and guarantee that it
>> is properly aligned before continuing (though Im guessing this will
>> break a lot of users...)
>>> timestamp in it. I think data should really be in the state struct.
>> Yes, with a proper __aligned(8) attribute... Or couldn't we just use
>> __aligned(8) on the stack variable?
> Forcing alignment on the stack isn't terribly reliable, which is why
> we never do that for dma safe buffers.
>
> Probably better to just move it to the state structure.
> I'll fix it up to do that. Please sanity check what will shortly
> be in the testing branch.
>
> The moment Lars mentioned this I groaned. As you've noted a few other
> drivers have the same problem + the ABI doesn't clearly state
> or check this.
>
> We should certainly fix all the drivers that suffer this problem
> first then we can think about adding a runtime check.

It looks like it is actually quite a few drivers, maybe we should switch 
to put_unaligned(). We probably got lucky in most cases and the buffer 
is naturally aligned to 64 bit.

But the reason I noticed this is because I ran into the issue in the 
wild where the timestamp ended up at the wrong offset in the buffer, so 
it does happen.

The following semantic patch finds affected drivers.

@@
type T;
identifier buf;
expression N;
expression ts;
expression indio_dev;
@@
*T buf[N];
...
*iio_push_to_buffers_with_timestamp(indio_dev, buf, ts)

Matched files:

--- drivers/iio/health/afe4403.c
--- drivers/iio/health/afe4404.c
--- drivers/iio/gyro/mpu3050-core.c
--- drivers/iio/gyro/itg3200_buffer.c
--- drivers/iio/chemical/ccs811.c
--- drivers/iio/chemical/sps30.c
--- drivers/iio/chemical/pms7003.c
--- drivers/iio/proximity/isl29501.c
--- drivers/iio/proximity/mb1232.c
--- drivers/iio/accel/kxsd9.c
--- drivers/iio/accel/mma8452.c
--- drivers/iio/accel/bmc150-accel-core.c
--- drivers/iio/accel/mma7455_core.c
--- drivers/iio/adc/ti-adc081c.c
--- drivers/iio/adc/ti-adc084s021.c
--- drivers/iio/adc/ti-ads1015.c
--- drivers/iio/adc/ti-ads124s08.c
--- drivers/iio/adc/ina2xx-adc.c
--- drivers/iio/adc/ti-ads8688.c
--- drivers/iio/adc/ti-adc0832.c
--- drivers/iio/adc/ti-adc12138.c
--- drivers/iio/adc/max1118.c
--- drivers/iio/adc/ad_sigma_delta.c
--- drivers/iio/light/si1145.c
--- drivers/iio/light/vcnl4035.c
--- drivers/iio/light/max44000.c
--- drivers/iio/light/rpr0521.c
--- drivers/iio/light/st_uvis25_core.c
--- drivers/iio/light/ltr501.c
--- drivers/iio/magnetometer/ak8974.c
--- drivers/iio/magnetometer/mag3110.c
--- drivers/iio/magnetometer/ak8975.c
--- drivers/iio/humidity/hdc100x.c
--- drivers/iio/humidity/hts221_buffer.c
--- drivers/iio/imu/bmi160/bmi160_core.c
--- drivers/iio/imu/st_lsm6dsx/st_lsm6dsx_buffer.c
--- drivers/iio/imu/inv_mpu6050/inv_mpu_ring.c
--- drivers/iio/pressure/ms5611_core.c
--- drivers/iio/pressure/mpl3115.c


^ permalink raw reply	[flat|nested] 24+ messages in thread

* Re: [PATCH v5 5/6] iio: imu: Add support for adis16475
  2020-05-03  9:07             ` Lars-Peter Clausen
@ 2020-05-03  9:12               ` Lars-Peter Clausen
  2020-05-17 16:15                 ` Jonathan Cameron
  2020-05-03 11:07               ` Nuno Sá
  1 sibling, 1 reply; 24+ messages in thread
From: Lars-Peter Clausen @ 2020-05-03  9:12 UTC (permalink / raw)
  To: Jonathan Cameron, Nuno Sá
  Cc: Nuno Sá,
	linux-iio, devicetree, Hartmut Knaack, Peter Meerwald-Stadler,
	Rob Herring, Mark Rutland, Alexandru Ardelean, Michael Hennerich

On 5/3/20 11:07 AM, Lars-Peter Clausen wrote:
> On 5/3/20 10:47 AM, Jonathan Cameron wrote:
>> On Sat, 02 May 2020 21:52:18 +0200
>> Nuno Sá <noname.nuno@gmail.com> wrote:
>>
>>> On Sat, 2020-05-02 at 20:01 +0200, Lars-Peter Clausen wrote:
>>>> On 5/2/20 7:40 PM, Jonathan Cameron wrote:
>>>>> On Mon, 27 Apr 2020 20:06:07 +0200
>>>>> Lars-Peter Clausen <lars@metafoo.de> wrote:
>>>>>> On 4/13/20 10:24 AM, Nuno Sá wrote:
>>>>>>> [...]
>>>>>>> +static irqreturn_t adis16475_trigger_handler(int irq, void *p)
>>>>>>> +{
>>>>>>> [...]
>>>>>>> +    __be16 data[ADIS16475_MAX_SCAN_DATA], *buffer;
>>>>>>> [...]
>>>>>>> +
>>>>>>> +    iio_push_to_buffers_with_timestamp(indio_dev, data, pf-
>>>>>>>> timestamp);
>>>>>> If the timestamp is enabled the IIO core might insert padding
>>>>>> between
>>>>>> the data channels and the timestamp. If that happens this will
>>>>>> disclose
>>>>>> kernel stack memory to userspace.
>>>>>>
>>>>>> This needs either a memset(data, 0x00, sizeof(data)) or maybe put
>>>>>> data
>>>>>> into the state struct and kzalloc it.
>>>>> Good spot. Could simply do __be16 data[ADI..] = {0}; rather than
>>>>> explicit
>>>>> memset, but some form of zeroization is needed.
>>>>>
>>>>> I've fixed up the applied patch with the above approach.
>>>> There is actually another issue. The stack data is not necessarily
>>>> aligned to 64 bit, which causes issues if we try to put the 64-bit
>>> Oh, this is actually more problematic. Yes, since we have an array of
>>> u16, that is not guaranteed to be 64bit aligned. Doing a quick search
>>> of `iio_push_to_buffers_with_timestamp()` users and I could quickly
>>> find 4/5 drivers with the same problem. I guess the API should clearly
>>> state that `data` needs to be __at least__ 64 bits aligned (maybe a
>>> future patch). Or we could even check the address and guarantee that it
>>> is properly aligned before continuing (though Im guessing this will
>>> break a lot of users...)
>>>> timestamp in it. I think data should really be in the state struct.
>>> Yes, with a proper __aligned(8) attribute... Or couldn't we just use
>>> __aligned(8) on the stack variable?
>> Forcing alignment on the stack isn't terribly reliable, which is why
>> we never do that for dma safe buffers.
>>
>> Probably better to just move it to the state structure.
>> I'll fix it up to do that. Please sanity check what will shortly
>> be in the testing branch.
>>
>> The moment Lars mentioned this I groaned. As you've noted a few other
>> drivers have the same problem + the ABI doesn't clearly state
>> or check this.
>>
>> We should certainly fix all the drivers that suffer this problem
>> first then we can think about adding a runtime check.
>
> It looks like it is actually quite a few drivers, maybe we should 
> switch to put_unaligned(). We probably got lucky in most cases and the 
> buffer is naturally aligned to 64 bit.
>
> But the reason I noticed this is because I ran into the issue in the 
> wild where the timestamp ended up at the wrong offset in the buffer, 
> so it does happen.
>
> The following semantic patch finds affected drivers.
>
> @@
> type T;
> identifier buf;
> expression N;
> expression ts;
> expression indio_dev;
> @@
> *T buf[N];
> ...
> *iio_push_to_buffers_with_timestamp(indio_dev, buf, ts)
>
> Matched files:
>
> --- drivers/iio/health/afe4403.c
> --- drivers/iio/health/afe4404.c
> --- drivers/iio/gyro/mpu3050-core.c
> --- drivers/iio/gyro/itg3200_buffer.c
> --- drivers/iio/chemical/ccs811.c
> --- drivers/iio/chemical/sps30.c
> --- drivers/iio/chemical/pms7003.c
> --- drivers/iio/proximity/isl29501.c
> --- drivers/iio/proximity/mb1232.c
> --- drivers/iio/accel/kxsd9.c
> --- drivers/iio/accel/mma8452.c
> --- drivers/iio/accel/bmc150-accel-core.c
> --- drivers/iio/accel/mma7455_core.c
> --- drivers/iio/adc/ti-adc081c.c
> --- drivers/iio/adc/ti-adc084s021.c
> --- drivers/iio/adc/ti-ads1015.c
> --- drivers/iio/adc/ti-ads124s08.c
> --- drivers/iio/adc/ina2xx-adc.c
> --- drivers/iio/adc/ti-ads8688.c
> --- drivers/iio/adc/ti-adc0832.c
> --- drivers/iio/adc/ti-adc12138.c
> --- drivers/iio/adc/max1118.c
> --- drivers/iio/adc/ad_sigma_delta.c
> --- drivers/iio/light/si1145.c
> --- drivers/iio/light/vcnl4035.c
> --- drivers/iio/light/max44000.c
> --- drivers/iio/light/rpr0521.c
> --- drivers/iio/light/st_uvis25_core.c
> --- drivers/iio/light/ltr501.c
> --- drivers/iio/magnetometer/ak8974.c
> --- drivers/iio/magnetometer/mag3110.c
> --- drivers/iio/magnetometer/ak8975.c
> --- drivers/iio/humidity/hdc100x.c
> --- drivers/iio/humidity/hts221_buffer.c
> --- drivers/iio/imu/bmi160/bmi160_core.c
> --- drivers/iio/imu/st_lsm6dsx/st_lsm6dsx_buffer.c
> --- drivers/iio/imu/inv_mpu6050/inv_mpu_ring.c
> --- drivers/iio/pressure/ms5611_core.c
> --- drivers/iio/pressure/mpl3115.c
>
Most of these drivers also seem to have the issue that they leak stack 
memory. Only 11 of them clear the buffer.


^ permalink raw reply	[flat|nested] 24+ messages in thread

* Re: [PATCH v5 5/6] iio: imu: Add support for adis16475
  2020-05-03  9:07             ` Lars-Peter Clausen
  2020-05-03  9:12               ` Lars-Peter Clausen
@ 2020-05-03 11:07               ` Nuno Sá
  2020-05-03 11:29                 ` Jonathan Cameron
  1 sibling, 1 reply; 24+ messages in thread
From: Nuno Sá @ 2020-05-03 11:07 UTC (permalink / raw)
  To: Lars-Peter Clausen, Jonathan Cameron
  Cc: Nuno Sá,
	linux-iio, devicetree, Hartmut Knaack, Peter Meerwald-Stadler,
	Rob Herring, Mark Rutland, Alexandru Ardelean, Michael Hennerich

On Sun, 2020-05-03 at 11:07 +0200, Lars-Peter Clausen wrote:
> On 5/3/20 10:47 AM, Jonathan Cameron wrote:
> > On Sat, 02 May 2020 21:52:18 +0200
> > Nuno Sá <noname.nuno@gmail.com> wrote:
> > 
> > > On Sat, 2020-05-02 at 20:01 +0200, Lars-Peter Clausen wrote:
> > > > On 5/2/20 7:40 PM, Jonathan Cameron wrote:
> > > > > On Mon, 27 Apr 2020 20:06:07 +0200
> > > > > Lars-Peter Clausen <lars@metafoo.de> wrote:
> > > > >    
> > > > > > On 4/13/20 10:24 AM, Nuno Sá wrote:
> > > > > > > [...]
> > > > > > > +static irqreturn_t adis16475_trigger_handler(int irq,
> > > > > > > void *p)
> > > > > > > +{
> > > > > > > [...]
> > > > > > > +	__be16 data[ADIS16475_MAX_SCAN_DATA], *buffer;
> > > > > > > [...]
> > > > > > > +
> > > > > > > +	iio_push_to_buffers_with_timestamp(indio_dev, data, pf-
> > > > > > > > timestamp);
> > > > > > If the timestamp is enabled the IIO core might insert
> > > > > > padding
> > > > > > between
> > > > > > the data channels and the timestamp. If that happens this
> > > > > > will
> > > > > > disclose
> > > > > > kernel stack memory to userspace.
> > > > > > 
> > > > > > This needs either a memset(data, 0x00, sizeof(data)) or
> > > > > > maybe put
> > > > > > data
> > > > > > into the state struct and kzalloc it.
> > > > > Good spot. Could simply do __be16 data[ADI..] = {0}; rather
> > > > > than
> > > > > explicit
> > > > > memset, but some form of zeroization is needed.
> > > > > 
> > > > > I've fixed up the applied patch with the above approach.
> > > > There is actually another issue. The stack data is not
> > > > necessarily
> > > > aligned to 64 bit, which causes issues if we try to put the 64-
> > > > bit
> > > Oh, this is actually more problematic. Yes, since we have an
> > > array of
> > > u16, that is not guaranteed to be 64bit aligned. Doing a quick
> > > search
> > > of `iio_push_to_buffers_with_timestamp()` users and I could
> > > quickly
> > > find 4/5 drivers with the same problem. I guess the API should
> > > clearly
> > > state that `data` needs to be __at least__ 64 bits aligned (maybe
> > > a
> > > future patch). Or we could even check the address and guarantee
> > > that it
> > > is properly aligned before continuing (though Im guessing this
> > > will
> > > break a lot of users...)
> > > > timestamp in it. I think data should really be in the state
> > > > struct.
> > > Yes, with a proper __aligned(8) attribute... Or couldn't we just
> > > use
> > > __aligned(8) on the stack variable?
> > Forcing alignment on the stack isn't terribly reliable, which is
> > why
> > we never do that for dma safe buffers.
> > 
> > Probably better to just move it to the state structure.
> > I'll fix it up to do that. Please sanity check what will shortly
> > be in the testing branch.
> > 
> > The moment Lars mentioned this I groaned. As you've noted a few
> > other
> > drivers have the same problem + the ABI doesn't clearly state
> > or check this.
> > 
> > We should certainly fix all the drivers that suffer this problem
> > first then we can think about adding a runtime check.
> 
> It looks like it is actually quite a few drivers, maybe we should
> switch 

Yeps, not surprised...

> to put_unaligned(). We probably got lucky in most cases and the
> buffer

This would keep us from having to fix all the users (just need to fix
the memory leakage you mention on the next email) to use a properly
aligned buffer. And later on, if we want, we can always add an
`aligned` variant of `iio_push_to_buffers_with_timestamp()` were we
check for alignment...

- Nuno Sá


^ permalink raw reply	[flat|nested] 24+ messages in thread

* Re: [PATCH v5 5/6] iio: imu: Add support for adis16475
  2020-05-03 11:07               ` Nuno Sá
@ 2020-05-03 11:29                 ` Jonathan Cameron
  2020-05-03 17:19                   ` Jonathan Cameron
  0 siblings, 1 reply; 24+ messages in thread
From: Jonathan Cameron @ 2020-05-03 11:29 UTC (permalink / raw)
  To: Nuno Sá
  Cc: Lars-Peter Clausen, Nuno Sá,
	linux-iio, devicetree, Hartmut Knaack, Peter Meerwald-Stadler,
	Rob Herring, Mark Rutland, Alexandru Ardelean, Michael Hennerich

On Sun, 03 May 2020 13:07:01 +0200
Nuno Sá <noname.nuno@gmail.com> wrote:

> On Sun, 2020-05-03 at 11:07 +0200, Lars-Peter Clausen wrote:
> > On 5/3/20 10:47 AM, Jonathan Cameron wrote:  
> > > On Sat, 02 May 2020 21:52:18 +0200
> > > Nuno Sá <noname.nuno@gmail.com> wrote:
> > >   
> > > > On Sat, 2020-05-02 at 20:01 +0200, Lars-Peter Clausen wrote:  
> > > > > On 5/2/20 7:40 PM, Jonathan Cameron wrote:  
> > > > > > On Mon, 27 Apr 2020 20:06:07 +0200
> > > > > > Lars-Peter Clausen <lars@metafoo.de> wrote:
> > > > > >      
> > > > > > > On 4/13/20 10:24 AM, Nuno Sá wrote:  
> > > > > > > > [...]
> > > > > > > > +static irqreturn_t adis16475_trigger_handler(int irq,
> > > > > > > > void *p)
> > > > > > > > +{
> > > > > > > > [...]
> > > > > > > > +	__be16 data[ADIS16475_MAX_SCAN_DATA], *buffer;
> > > > > > > > [...]
> > > > > > > > +
> > > > > > > > +	iio_push_to_buffers_with_timestamp(indio_dev, data, pf-  
> > > > > > > > > timestamp);  
> > > > > > > If the timestamp is enabled the IIO core might insert
> > > > > > > padding
> > > > > > > between
> > > > > > > the data channels and the timestamp. If that happens this
> > > > > > > will
> > > > > > > disclose
> > > > > > > kernel stack memory to userspace.
> > > > > > > 
> > > > > > > This needs either a memset(data, 0x00, sizeof(data)) or
> > > > > > > maybe put
> > > > > > > data
> > > > > > > into the state struct and kzalloc it.  
> > > > > > Good spot. Could simply do __be16 data[ADI..] = {0}; rather
> > > > > > than
> > > > > > explicit
> > > > > > memset, but some form of zeroization is needed.
> > > > > > 
> > > > > > I've fixed up the applied patch with the above approach.  
> > > > > There is actually another issue. The stack data is not
> > > > > necessarily
> > > > > aligned to 64 bit, which causes issues if we try to put the 64-
> > > > > bit  
> > > > Oh, this is actually more problematic. Yes, since we have an
> > > > array of
> > > > u16, that is not guaranteed to be 64bit aligned. Doing a quick
> > > > search
> > > > of `iio_push_to_buffers_with_timestamp()` users and I could
> > > > quickly
> > > > find 4/5 drivers with the same problem. I guess the API should
> > > > clearly
> > > > state that `data` needs to be __at least__ 64 bits aligned (maybe
> > > > a
> > > > future patch). Or we could even check the address and guarantee
> > > > that it
> > > > is properly aligned before continuing (though Im guessing this
> > > > will
> > > > break a lot of users...)  
> > > > > timestamp in it. I think data should really be in the state
> > > > > struct.  
> > > > Yes, with a proper __aligned(8) attribute... Or couldn't we just
> > > > use
> > > > __aligned(8) on the stack variable?  
> > > Forcing alignment on the stack isn't terribly reliable, which is
> > > why
> > > we never do that for dma safe buffers.
> > > 
> > > Probably better to just move it to the state structure.
> > > I'll fix it up to do that. Please sanity check what will shortly
> > > be in the testing branch.
> > > 
> > > The moment Lars mentioned this I groaned. As you've noted a few
> > > other
> > > drivers have the same problem + the ABI doesn't clearly state
> > > or check this.
> > > 
> > > We should certainly fix all the drivers that suffer this problem
> > > first then we can think about adding a runtime check.  
> > 
> > It looks like it is actually quite a few drivers, maybe we should
> > switch   
> 
> Yeps, not surprised...
> 
> > to put_unaligned(). We probably got lucky in most cases and the
> > buffer  
> 
> This would keep us from having to fix all the users (just need to fix
> the memory leakage you mention on the next email) to use a properly
> aligned buffer. And later on, if we want, we can always add an
> `aligned` variant of `iio_push_to_buffers_with_timestamp()` were we
> check for alignment...

I'd rather scrub the existing set to fix this.  The reason being
to make the point they were broken.  Fixing up with an unaligned
write in the core is not 'obvious' to people looking at whether
to pick up patches for individual drivers.

Unlikely to be too much extra over making sure we don't leak kernel
data.   If we move them to the iio_priv structure we will avoid that
anyway due to that being kzalloc ed in the first place.  We may
leak previous timestamps or read values, but we don't care about that.

It's been there a while, so no 'super hurry' to fix these up but
we should do it over next few months.

Jonathan

> 
> - Nuno Sá
> 


^ permalink raw reply	[flat|nested] 24+ messages in thread

* Re: [PATCH v5 5/6] iio: imu: Add support for adis16475
  2020-05-03 11:29                 ` Jonathan Cameron
@ 2020-05-03 17:19                   ` Jonathan Cameron
  2020-05-03 17:55                     ` Nuno Sá
  0 siblings, 1 reply; 24+ messages in thread
From: Jonathan Cameron @ 2020-05-03 17:19 UTC (permalink / raw)
  To: Nuno Sá
  Cc: Lars-Peter Clausen, Nuno Sá,
	linux-iio, devicetree, Hartmut Knaack, Peter Meerwald-Stadler,
	Rob Herring, Mark Rutland, Alexandru Ardelean, Michael Hennerich

On Sun, 3 May 2020 12:29:26 +0100
Jonathan Cameron <jic23@kernel.org> wrote:

> On Sun, 03 May 2020 13:07:01 +0200
> Nuno Sá <noname.nuno@gmail.com> wrote:
> 
> > On Sun, 2020-05-03 at 11:07 +0200, Lars-Peter Clausen wrote:  
> > > On 5/3/20 10:47 AM, Jonathan Cameron wrote:    
> > > > On Sat, 02 May 2020 21:52:18 +0200
> > > > Nuno Sá <noname.nuno@gmail.com> wrote:
> > > >     
> > > > > On Sat, 2020-05-02 at 20:01 +0200, Lars-Peter Clausen wrote:    
> > > > > > On 5/2/20 7:40 PM, Jonathan Cameron wrote:    
> > > > > > > On Mon, 27 Apr 2020 20:06:07 +0200
> > > > > > > Lars-Peter Clausen <lars@metafoo.de> wrote:
> > > > > > >        
> > > > > > > > On 4/13/20 10:24 AM, Nuno Sá wrote:    
> > > > > > > > > [...]
> > > > > > > > > +static irqreturn_t adis16475_trigger_handler(int irq,
> > > > > > > > > void *p)
> > > > > > > > > +{
> > > > > > > > > [...]
> > > > > > > > > +	__be16 data[ADIS16475_MAX_SCAN_DATA], *buffer;
> > > > > > > > > [...]
> > > > > > > > > +
> > > > > > > > > +	iio_push_to_buffers_with_timestamp(indio_dev, data, pf-    
> > > > > > > > > > timestamp);    
> > > > > > > > If the timestamp is enabled the IIO core might insert
> > > > > > > > padding
> > > > > > > > between
> > > > > > > > the data channels and the timestamp. If that happens this
> > > > > > > > will
> > > > > > > > disclose
> > > > > > > > kernel stack memory to userspace.
> > > > > > > > 
> > > > > > > > This needs either a memset(data, 0x00, sizeof(data)) or
> > > > > > > > maybe put
> > > > > > > > data
> > > > > > > > into the state struct and kzalloc it.    
> > > > > > > Good spot. Could simply do __be16 data[ADI..] = {0}; rather
> > > > > > > than
> > > > > > > explicit
> > > > > > > memset, but some form of zeroization is needed.
> > > > > > > 
> > > > > > > I've fixed up the applied patch with the above approach.    
> > > > > > There is actually another issue. The stack data is not
> > > > > > necessarily
> > > > > > aligned to 64 bit, which causes issues if we try to put the 64-
> > > > > > bit    
> > > > > Oh, this is actually more problematic. Yes, since we have an
> > > > > array of
> > > > > u16, that is not guaranteed to be 64bit aligned. Doing a quick
> > > > > search
> > > > > of `iio_push_to_buffers_with_timestamp()` users and I could
> > > > > quickly
> > > > > find 4/5 drivers with the same problem. I guess the API should
> > > > > clearly
> > > > > state that `data` needs to be __at least__ 64 bits aligned (maybe
> > > > > a
> > > > > future patch). Or we could even check the address and guarantee
> > > > > that it
> > > > > is properly aligned before continuing (though Im guessing this
> > > > > will
> > > > > break a lot of users...)    
> > > > > > timestamp in it. I think data should really be in the state
> > > > > > struct.    
> > > > > Yes, with a proper __aligned(8) attribute... Or couldn't we just
> > > > > use
> > > > > __aligned(8) on the stack variable?    
> > > > Forcing alignment on the stack isn't terribly reliable, which is
> > > > why
> > > > we never do that for dma safe buffers.
> > > > 
> > > > Probably better to just move it to the state structure.
> > > > I'll fix it up to do that. Please sanity check what will shortly
> > > > be in the testing branch.
> > > > 
> > > > The moment Lars mentioned this I groaned. As you've noted a few
> > > > other
> > > > drivers have the same problem + the ABI doesn't clearly state
> > > > or check this.
> > > > 
> > > > We should certainly fix all the drivers that suffer this problem
> > > > first then we can think about adding a runtime check.    
> > > 
> > > It looks like it is actually quite a few drivers, maybe we should
> > > switch     
> > 
> > Yeps, not surprised...
> >   
> > > to put_unaligned(). We probably got lucky in most cases and the
> > > buffer    
> > 
> > This would keep us from having to fix all the users (just need to fix
> > the memory leakage you mention on the next email) to use a properly
> > aligned buffer. And later on, if we want, we can always add an
> > `aligned` variant of `iio_push_to_buffers_with_timestamp()` were we
> > check for alignment...  
> 
> I'd rather scrub the existing set to fix this.  The reason being
> to make the point they were broken.  Fixing up with an unaligned
> write in the core is not 'obvious' to people looking at whether
> to pick up patches for individual drivers.
> 
> Unlikely to be too much extra over making sure we don't leak kernel
> data.   If we move them to the iio_priv structure we will avoid that
> anyway due to that being kzalloc ed in the first place.  We may
> leak previous timestamps or read values, but we don't care about that.
> 
> It's been there a while, so no 'super hurry' to fix these up but
> we should do it over next few months.

It's also worth noticing that there is some care needed.
Some devices don't need to zero because there is no padding.
Some devices are using the core demux, so the timestamp is always
in the same place, hence can be nicely refactored to an explicit
structure, either on the stack or heap.

Anyhow, from the first few I looked at I suspect they are all going
to have slightly different optimal solutions.

Take a look at the kxsd9 patch I'll send in a minute.  For that one
I think the cleanest thing is to leave the variable on the stack
but use an explicit structure to ensure the alignment is correct.

I'll look to do a few of these at a time over the next few weeks
as each one needs fairly careful review.

Jonathan

> 
> Jonathan
> 
> > 
> > - Nuno Sá
> >   
> 


^ permalink raw reply	[flat|nested] 24+ messages in thread

* Re: [PATCH v5 5/6] iio: imu: Add support for adis16475
  2020-05-03 17:19                   ` Jonathan Cameron
@ 2020-05-03 17:55                     ` Nuno Sá
  0 siblings, 0 replies; 24+ messages in thread
From: Nuno Sá @ 2020-05-03 17:55 UTC (permalink / raw)
  To: Jonathan Cameron
  Cc: Lars-Peter Clausen, Nuno Sá,
	linux-iio, devicetree, Hartmut Knaack, Peter Meerwald-Stadler,
	Rob Herring, Mark Rutland, Alexandru Ardelean, Michael Hennerich

On Sun, 2020-05-03 at 18:19 +0100, Jonathan Cameron wrote:
> On Sun, 3 May 2020 12:29:26 +0100
> Jonathan Cameron <jic23@kernel.org> wrote:
> 
> > On Sun, 03 May 2020 13:07:01 +0200
> > Nuno Sá <noname.nuno@gmail.com> wrote:
> > 
> > > On Sun, 2020-05-03 at 11:07 +0200, Lars-Peter Clausen wrote:  
> > > > On 5/3/20 10:47 AM, Jonathan Cameron wrote:    
> > > > > On Sat, 02 May 2020 21:52:18 +0200
> > > > > Nuno Sá <noname.nuno@gmail.com> wrote:
> > > > >     
> > > > > > On Sat, 2020-05-02 at 20:01 +0200, Lars-Peter Clausen
> > > > > > wrote:    
> > > > > > > On 5/2/20 7:40 PM, Jonathan Cameron wrote:    
> > > > > > > > On Mon, 27 Apr 2020 20:06:07 +0200
> > > > > > > > Lars-Peter Clausen <lars@metafoo.de> wrote:
> > > > > > > >        
> > > > > > > > > On 4/13/20 10:24 AM, Nuno Sá wrote:    
> > > > > > > > > > [...]
> > > > > > > > > > +static irqreturn_t adis16475_trigger_handler(int
> > > > > > > > > > irq,
> > > > > > > > > > void *p)
> > > > > > > > > > +{
> > > > > > > > > > [...]
> > > > > > > > > > +	__be16 data[ADIS16475_MAX_SCAN_DATA], *buffer;
> > > > > > > > > > [...]
> > > > > > > > > > +
> > > > > > > > > > +	iio_push_to_buffers_with_timestamp(indio_dev,
> > > > > > > > > > data, pf-    
> > > > > > > > > > > timestamp);    
> > > > > > > > > If the timestamp is enabled the IIO core might insert
> > > > > > > > > padding
> > > > > > > > > between
> > > > > > > > > the data channels and the timestamp. If that happens
> > > > > > > > > this
> > > > > > > > > will
> > > > > > > > > disclose
> > > > > > > > > kernel stack memory to userspace.
> > > > > > > > > 
> > > > > > > > > This needs either a memset(data, 0x00, sizeof(data))
> > > > > > > > > or
> > > > > > > > > maybe put
> > > > > > > > > data
> > > > > > > > > into the state struct and kzalloc it.    
> > > > > > > > Good spot. Could simply do __be16 data[ADI..] = {0};
> > > > > > > > rather
> > > > > > > > than
> > > > > > > > explicit
> > > > > > > > memset, but some form of zeroization is needed.
> > > > > > > > 
> > > > > > > > I've fixed up the applied patch with the above
> > > > > > > > approach.    
> > > > > > > There is actually another issue. The stack data is not
> > > > > > > necessarily
> > > > > > > aligned to 64 bit, which causes issues if we try to put
> > > > > > > the 64-
> > > > > > > bit    
> > > > > > Oh, this is actually more problematic. Yes, since we have
> > > > > > an
> > > > > > array of
> > > > > > u16, that is not guaranteed to be 64bit aligned. Doing a
> > > > > > quick
> > > > > > search
> > > > > > of `iio_push_to_buffers_with_timestamp()` users and I could
> > > > > > quickly
> > > > > > find 4/5 drivers with the same problem. I guess the API
> > > > > > should
> > > > > > clearly
> > > > > > state that `data` needs to be __at least__ 64 bits aligned
> > > > > > (maybe
> > > > > > a
> > > > > > future patch). Or we could even check the address and
> > > > > > guarantee
> > > > > > that it
> > > > > > is properly aligned before continuing (though Im guessing
> > > > > > this
> > > > > > will
> > > > > > break a lot of users...)    
> > > > > > > timestamp in it. I think data should really be in the
> > > > > > > state
> > > > > > > struct.    
> > > > > > Yes, with a proper __aligned(8) attribute... Or couldn't we
> > > > > > just
> > > > > > use
> > > > > > __aligned(8) on the stack variable?    
> > > > > Forcing alignment on the stack isn't terribly reliable, which
> > > > > is
> > > > > why
> > > > > we never do that for dma safe buffers.
> > > > > 
> > > > > Probably better to just move it to the state structure.
> > > > > I'll fix it up to do that. Please sanity check what will
> > > > > shortly
> > > > > be in the testing branch.
> > > > > 
> > > > > The moment Lars mentioned this I groaned. As you've noted a
> > > > > few
> > > > > other
> > > > > drivers have the same problem + the ABI doesn't clearly state
> > > > > or check this.
> > > > > 
> > > > > We should certainly fix all the drivers that suffer this
> > > > > problem
> > > > > first then we can think about adding a runtime check.    
> > > > 
> > > > It looks like it is actually quite a few drivers, maybe we
> > > > should
> > > > switch     
> > > 
> > > Yeps, not surprised...
> > >   
> > > > to put_unaligned(). We probably got lucky in most cases and the
> > > > buffer    
> > > 
> > > This would keep us from having to fix all the users (just need to
> > > fix
> > > the memory leakage you mention on the next email) to use a
> > > properly
> > > aligned buffer. And later on, if we want, we can always add an
> > > `aligned` variant of `iio_push_to_buffers_with_timestamp()` were
> > > we
> > > check for alignment...  
> > 
> > I'd rather scrub the existing set to fix this.  The reason being
> > to make the point they were broken.  Fixing up with an unaligned
> > write in the core is not 'obvious' to people looking at whether
> > to pick up patches for individual drivers.
> > 
> > Unlikely to be too much extra over making sure we don't leak kernel
> > data.   If we move them to the iio_priv structure we will avoid
> > that
> > anyway due to that being kzalloc ed in the first place.  We may
> > leak previous timestamps or read values, but we don't care about
> > that.
> > 
> > It's been there a while, so no 'super hurry' to fix these up but
> > we should do it over next few months.
> 
> It's also worth noticing that there is some care needed.
> Some devices don't need to zero because there is no padding.
> Some devices are using the core demux, so the timestamp is always
> in the same place, hence can be nicely refactored to an explicit
> structure, either on the stack or heap.
> 
> Anyhow, from the first few I looked at I suspect they are all going
> to have slightly different optimal solutions.
> 
> Take a look at the kxsd9 patch I'll send in a minute.  For that one
> I think the cleanest thing is to leave the variable on the stack
> but use an explicit structure to ensure the alignment is correct.

Agreed. In those cases where there is no padding for the timestamp we
can leave the variable on the stack (we can even think about adding an helper macro to declare this kind of construct :D). For the other's we can make use of iio_priv being kzalloc at probe so that we don't leak kernel data...

- Nuno Sá
> 
> 
> Jonathan
> 
> > Jonathan
> > 
> > > - Nuno Sá
> > >   


^ permalink raw reply	[flat|nested] 24+ messages in thread

* Re: [PATCH v5 5/6] iio: imu: Add support for adis16475
  2020-05-03  9:12               ` Lars-Peter Clausen
@ 2020-05-17 16:15                 ` Jonathan Cameron
  2020-05-17 19:07                   ` Lars-Peter Clausen
  0 siblings, 1 reply; 24+ messages in thread
From: Jonathan Cameron @ 2020-05-17 16:15 UTC (permalink / raw)
  To: Lars-Peter Clausen
  Cc: Nuno Sá, Nuno Sá,
	linux-iio, devicetree, Hartmut Knaack, Peter Meerwald-Stadler,
	Rob Herring, Mark Rutland, Alexandru Ardelean, Michael Hennerich

On Sun, 3 May 2020 11:12:34 +0200
Lars-Peter Clausen <lars@metafoo.de> wrote:

> On 5/3/20 11:07 AM, Lars-Peter Clausen wrote:
> > On 5/3/20 10:47 AM, Jonathan Cameron wrote:  
> >> On Sat, 02 May 2020 21:52:18 +0200
> >> Nuno Sá <noname.nuno@gmail.com> wrote:
> >>  
> >>> On Sat, 2020-05-02 at 20:01 +0200, Lars-Peter Clausen wrote:  
> >>>> On 5/2/20 7:40 PM, Jonathan Cameron wrote:  
> >>>>> On Mon, 27 Apr 2020 20:06:07 +0200
> >>>>> Lars-Peter Clausen <lars@metafoo.de> wrote:  
> >>>>>> On 4/13/20 10:24 AM, Nuno Sá wrote:  
> >>>>>>> [...]
> >>>>>>> +static irqreturn_t adis16475_trigger_handler(int irq, void *p)
> >>>>>>> +{
> >>>>>>> [...]
> >>>>>>> +    __be16 data[ADIS16475_MAX_SCAN_DATA], *buffer;
> >>>>>>> [...]
> >>>>>>> +
> >>>>>>> +    iio_push_to_buffers_with_timestamp(indio_dev, data, pf-  
> >>>>>>>> timestamp);  
> >>>>>> If the timestamp is enabled the IIO core might insert padding
> >>>>>> between
> >>>>>> the data channels and the timestamp. If that happens this will
> >>>>>> disclose
> >>>>>> kernel stack memory to userspace.
> >>>>>>
> >>>>>> This needs either a memset(data, 0x00, sizeof(data)) or maybe put
> >>>>>> data
> >>>>>> into the state struct and kzalloc it.  
> >>>>> Good spot. Could simply do __be16 data[ADI..] = {0}; rather than
> >>>>> explicit
> >>>>> memset, but some form of zeroization is needed.
> >>>>>
> >>>>> I've fixed up the applied patch with the above approach.  
> >>>> There is actually another issue. The stack data is not necessarily
> >>>> aligned to 64 bit, which causes issues if we try to put the 64-bit  
> >>> Oh, this is actually more problematic. Yes, since we have an array of
> >>> u16, that is not guaranteed to be 64bit aligned. Doing a quick search
> >>> of `iio_push_to_buffers_with_timestamp()` users and I could quickly
> >>> find 4/5 drivers with the same problem. I guess the API should clearly
> >>> state that `data` needs to be __at least__ 64 bits aligned (maybe a
> >>> future patch). Or we could even check the address and guarantee that it
> >>> is properly aligned before continuing (though Im guessing this will
> >>> break a lot of users...)  
> >>>> timestamp in it. I think data should really be in the state struct.  
> >>> Yes, with a proper __aligned(8) attribute... Or couldn't we just use
> >>> __aligned(8) on the stack variable?  
> >> Forcing alignment on the stack isn't terribly reliable, which is why
> >> we never do that for dma safe buffers.
> >>
> >> Probably better to just move it to the state structure.
> >> I'll fix it up to do that. Please sanity check what will shortly
> >> be in the testing branch.
> >>
> >> The moment Lars mentioned this I groaned. As you've noted a few other
> >> drivers have the same problem + the ABI doesn't clearly state
> >> or check this.
> >>
> >> We should certainly fix all the drivers that suffer this problem
> >> first then we can think about adding a runtime check.  
> >
> > It looks like it is actually quite a few drivers, maybe we should 
> > switch to put_unaligned(). We probably got lucky in most cases and the 
> > buffer is naturally aligned to 64 bit.

Just a quick update on this.  I've been taking a deeper look and there
are some 'interesting' cases in here so the put_unaligned is attractive
unfortunately I don't think we can go that way because it would be
reasonable for consumers of the buffer to expect it to be appropriately
aligned.   We need to rework many of these anyway to fix the related
data leak.

I've done some of below and will post shortly - a few will take more
effort and probably need testing rather than just relying on review.

So far the 'interesting ones' are mpu3050 and isl29501.

J

> >
> > But the reason I noticed this is because I ran into the issue in the 
> > wild where the timestamp ended up at the wrong offset in the buffer, 
> > so it does happen.
> >
> > The following semantic patch finds affected drivers.
> >
> > @@
> > type T;
> > identifier buf;
> > expression N;
> > expression ts;
> > expression indio_dev;
> > @@
> > *T buf[N];
> > ...
> > *iio_push_to_buffers_with_timestamp(indio_dev, buf, ts)
> >
> > Matched files:
> >
> > --- drivers/iio/health/afe4403.c
> > --- drivers/iio/health/afe4404.c
> > --- drivers/iio/gyro/mpu3050-core.c
> > --- drivers/iio/gyro/itg3200_buffer.c
> > --- drivers/iio/chemical/ccs811.c
> > --- drivers/iio/chemical/sps30.c
> > --- drivers/iio/chemical/pms7003.c
> > --- drivers/iio/proximity/isl29501.c
> > --- drivers/iio/proximity/mb1232.c
> > --- drivers/iio/accel/kxsd9.c
> > --- drivers/iio/accel/mma8452.c
> > --- drivers/iio/accel/bmc150-accel-core.c
> > --- drivers/iio/accel/mma7455_core.c
> > --- drivers/iio/adc/ti-adc081c.c
> > --- drivers/iio/adc/ti-adc084s021.c
> > --- drivers/iio/adc/ti-ads1015.c
> > --- drivers/iio/adc/ti-ads124s08.c
> > --- drivers/iio/adc/ina2xx-adc.c
> > --- drivers/iio/adc/ti-ads8688.c
> > --- drivers/iio/adc/ti-adc0832.c
> > --- drivers/iio/adc/ti-adc12138.c
> > --- drivers/iio/adc/max1118.c
> > --- drivers/iio/adc/ad_sigma_delta.c
> > --- drivers/iio/light/si1145.c
> > --- drivers/iio/light/vcnl4035.c
> > --- drivers/iio/light/max44000.c
> > --- drivers/iio/light/rpr0521.c
> > --- drivers/iio/light/st_uvis25_core.c
> > --- drivers/iio/light/ltr501.c
> > --- drivers/iio/magnetometer/ak8974.c
> > --- drivers/iio/magnetometer/mag3110.c
> > --- drivers/iio/magnetometer/ak8975.c
> > --- drivers/iio/humidity/hdc100x.c
> > --- drivers/iio/humidity/hts221_buffer.c
> > --- drivers/iio/imu/bmi160/bmi160_core.c
> > --- drivers/iio/imu/st_lsm6dsx/st_lsm6dsx_buffer.c
> > --- drivers/iio/imu/inv_mpu6050/inv_mpu_ring.c
> > --- drivers/iio/pressure/ms5611_core.c
> > --- drivers/iio/pressure/mpl3115.c
> >  
> Most of these drivers also seem to have the issue that they leak stack 
> memory. Only 11 of them clear the buffer.
> 


^ permalink raw reply	[flat|nested] 24+ messages in thread

* Re: [PATCH v5 5/6] iio: imu: Add support for adis16475
  2020-05-17 16:15                 ` Jonathan Cameron
@ 2020-05-17 19:07                   ` Lars-Peter Clausen
  2020-05-18 16:29                     ` Jonathan Cameron
  0 siblings, 1 reply; 24+ messages in thread
From: Lars-Peter Clausen @ 2020-05-17 19:07 UTC (permalink / raw)
  To: Jonathan Cameron
  Cc: Nuno Sá, Nuno Sá,
	linux-iio, devicetree, Hartmut Knaack, Peter Meerwald-Stadler,
	Rob Herring, Mark Rutland, Alexandru Ardelean, Michael Hennerich

On 5/17/20 6:15 PM, Jonathan Cameron wrote:
> On Sun, 3 May 2020 11:12:34 +0200
> Lars-Peter Clausen <lars@metafoo.de> wrote:
>
>> On 5/3/20 11:07 AM, Lars-Peter Clausen wrote:
>>> On 5/3/20 10:47 AM, Jonathan Cameron wrote:
>>>> On Sat, 02 May 2020 21:52:18 +0200
>>>> Nuno Sá <noname.nuno@gmail.com> wrote:
>>>>   
>>>>> On Sat, 2020-05-02 at 20:01 +0200, Lars-Peter Clausen wrote:
>>>>>> On 5/2/20 7:40 PM, Jonathan Cameron wrote:
>>>>>>> On Mon, 27 Apr 2020 20:06:07 +0200
>>>>>>> Lars-Peter Clausen <lars@metafoo.de> wrote:
>>>>>>>> On 4/13/20 10:24 AM, Nuno Sá wrote:
>>>>>>>>> [...]
>>>>>>>>> +static irqreturn_t adis16475_trigger_handler(int irq, void *p)
>>>>>>>>> +{
>>>>>>>>> [...]
>>>>>>>>> +    __be16 data[ADIS16475_MAX_SCAN_DATA], *buffer;
>>>>>>>>> [...]
>>>>>>>>> +
>>>>>>>>> +    iio_push_to_buffers_with_timestamp(indio_dev, data, pf-
>>>>>>>>>> timestamp);
>>>>>>>> If the timestamp is enabled the IIO core might insert padding
>>>>>>>> between
>>>>>>>> the data channels and the timestamp. If that happens this will
>>>>>>>> disclose
>>>>>>>> kernel stack memory to userspace.
>>>>>>>>
>>>>>>>> This needs either a memset(data, 0x00, sizeof(data)) or maybe put
>>>>>>>> data
>>>>>>>> into the state struct and kzalloc it.
>>>>>>> Good spot. Could simply do __be16 data[ADI..] = {0}; rather than
>>>>>>> explicit
>>>>>>> memset, but some form of zeroization is needed.
>>>>>>>
>>>>>>> I've fixed up the applied patch with the above approach.
>>>>>> There is actually another issue. The stack data is not necessarily
>>>>>> aligned to 64 bit, which causes issues if we try to put the 64-bit
>>>>> Oh, this is actually more problematic. Yes, since we have an array of
>>>>> u16, that is not guaranteed to be 64bit aligned. Doing a quick search
>>>>> of `iio_push_to_buffers_with_timestamp()` users and I could quickly
>>>>> find 4/5 drivers with the same problem. I guess the API should clearly
>>>>> state that `data` needs to be __at least__ 64 bits aligned (maybe a
>>>>> future patch). Or we could even check the address and guarantee that it
>>>>> is properly aligned before continuing (though Im guessing this will
>>>>> break a lot of users...)
>>>>>> timestamp in it. I think data should really be in the state struct.
>>>>> Yes, with a proper __aligned(8) attribute... Or couldn't we just use
>>>>> __aligned(8) on the stack variable?
>>>> Forcing alignment on the stack isn't terribly reliable, which is why
>>>> we never do that for dma safe buffers.
>>>>
>>>> Probably better to just move it to the state structure.
>>>> I'll fix it up to do that. Please sanity check what will shortly
>>>> be in the testing branch.
>>>>
>>>> The moment Lars mentioned this I groaned. As you've noted a few other
>>>> drivers have the same problem + the ABI doesn't clearly state
>>>> or check this.
>>>>
>>>> We should certainly fix all the drivers that suffer this problem
>>>> first then we can think about adding a runtime check.
>>> It looks like it is actually quite a few drivers, maybe we should
>>> switch to put_unaligned(). We probably got lucky in most cases and the
>>> buffer is naturally aligned to 64 bit.
> Just a quick update on this.  I've been taking a deeper look and there
> are some 'interesting' cases in here so the put_unaligned is attractive
> unfortunately I don't think we can go that way because it would be
> reasonable for consumers of the buffer to expect it to be appropriately
> aligned.   We need to rework many of these anyway to fix the related
> data leak.
>
> I've done some of below and will post shortly - a few will take more
> effort and probably need testing rather than just relying on review.
>
> So far the 'interesting ones' are mpu3050 and isl29501.

isl29501 looks OK to me. mpu3050 is clearly broken, buffer is both 
unaligned and too small!


^ permalink raw reply	[flat|nested] 24+ messages in thread

* Re: [PATCH v5 5/6] iio: imu: Add support for adis16475
  2020-05-17 19:07                   ` Lars-Peter Clausen
@ 2020-05-18 16:29                     ` Jonathan Cameron
  0 siblings, 0 replies; 24+ messages in thread
From: Jonathan Cameron @ 2020-05-18 16:29 UTC (permalink / raw)
  To: Lars-Peter Clausen
  Cc: Jonathan Cameron, Nuno Sá, Nuno Sá,
	linux-iio, devicetree, Hartmut Knaack, Peter Meerwald-Stadler,
	Rob Herring, Mark Rutland, Alexandru Ardelean, Michael Hennerich

On Sun, 17 May 2020 21:07:45 +0200
Lars-Peter Clausen <lars@metafoo.de> wrote:

> On 5/17/20 6:15 PM, Jonathan Cameron wrote:
> > On Sun, 3 May 2020 11:12:34 +0200
> > Lars-Peter Clausen <lars@metafoo.de> wrote:
> >  
> >> On 5/3/20 11:07 AM, Lars-Peter Clausen wrote:  
> >>> On 5/3/20 10:47 AM, Jonathan Cameron wrote:  
> >>>> On Sat, 02 May 2020 21:52:18 +0200
> >>>> Nuno Sá <noname.nuno@gmail.com> wrote:
> >>>>     
> >>>>> On Sat, 2020-05-02 at 20:01 +0200, Lars-Peter Clausen wrote:  
> >>>>>> On 5/2/20 7:40 PM, Jonathan Cameron wrote:  
> >>>>>>> On Mon, 27 Apr 2020 20:06:07 +0200
> >>>>>>> Lars-Peter Clausen <lars@metafoo.de> wrote:  
> >>>>>>>> On 4/13/20 10:24 AM, Nuno Sá wrote:  
> >>>>>>>>> [...]
> >>>>>>>>> +static irqreturn_t adis16475_trigger_handler(int irq, void *p)
> >>>>>>>>> +{
> >>>>>>>>> [...]
> >>>>>>>>> +    __be16 data[ADIS16475_MAX_SCAN_DATA], *buffer;
> >>>>>>>>> [...]
> >>>>>>>>> +
> >>>>>>>>> +    iio_push_to_buffers_with_timestamp(indio_dev, data, pf-  
> >>>>>>>>>> timestamp);  
> >>>>>>>> If the timestamp is enabled the IIO core might insert padding
> >>>>>>>> between
> >>>>>>>> the data channels and the timestamp. If that happens this will
> >>>>>>>> disclose
> >>>>>>>> kernel stack memory to userspace.
> >>>>>>>>
> >>>>>>>> This needs either a memset(data, 0x00, sizeof(data)) or maybe put
> >>>>>>>> data
> >>>>>>>> into the state struct and kzalloc it.  
> >>>>>>> Good spot. Could simply do __be16 data[ADI..] = {0}; rather than
> >>>>>>> explicit
> >>>>>>> memset, but some form of zeroization is needed.
> >>>>>>>
> >>>>>>> I've fixed up the applied patch with the above approach.  
> >>>>>> There is actually another issue. The stack data is not necessarily
> >>>>>> aligned to 64 bit, which causes issues if we try to put the 64-bit  
> >>>>> Oh, this is actually more problematic. Yes, since we have an array of
> >>>>> u16, that is not guaranteed to be 64bit aligned. Doing a quick search
> >>>>> of `iio_push_to_buffers_with_timestamp()` users and I could quickly
> >>>>> find 4/5 drivers with the same problem. I guess the API should clearly
> >>>>> state that `data` needs to be __at least__ 64 bits aligned (maybe a
> >>>>> future patch). Or we could even check the address and guarantee that it
> >>>>> is properly aligned before continuing (though Im guessing this will
> >>>>> break a lot of users...)  
> >>>>>> timestamp in it. I think data should really be in the state struct.  
> >>>>> Yes, with a proper __aligned(8) attribute... Or couldn't we just use
> >>>>> __aligned(8) on the stack variable?  
> >>>> Forcing alignment on the stack isn't terribly reliable, which is why
> >>>> we never do that for dma safe buffers.
> >>>>
> >>>> Probably better to just move it to the state structure.
> >>>> I'll fix it up to do that. Please sanity check what will shortly
> >>>> be in the testing branch.
> >>>>
> >>>> The moment Lars mentioned this I groaned. As you've noted a few other
> >>>> drivers have the same problem + the ABI doesn't clearly state
> >>>> or check this.
> >>>>
> >>>> We should certainly fix all the drivers that suffer this problem
> >>>> first then we can think about adding a runtime check.  
> >>> It looks like it is actually quite a few drivers, maybe we should
> >>> switch to put_unaligned(). We probably got lucky in most cases and the
> >>> buffer is naturally aligned to 64 bit.  
> > Just a quick update on this.  I've been taking a deeper look and there
> > are some 'interesting' cases in here so the put_unaligned is attractive
> > unfortunately I don't think we can go that way because it would be
> > reasonable for consumers of the buffer to expect it to be appropriately
> > aligned.   We need to rework many of these anyway to fix the related
> > data leak.
> >
> > I've done some of below and will post shortly - a few will take more
> > effort and probably need testing rather than just relying on review.
> >
> > So far the 'interesting ones' are mpu3050 and isl29501.  
> 
> isl29501 looks OK to me. mpu3050 is clearly broken, buffer is both 
> unaligned and too small!

isl29501 reads a pair of 8 bit registers, then writes them to a 32 bit value
for no particular reason and puts that in the first 32 bits of the buffer
having declared the channel to have a storage size of 16 bits.

So going to have some fun on one or other of the endian types...

J

> 



^ permalink raw reply	[flat|nested] 24+ messages in thread

end of thread, back to index

Thread overview: 24+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-04-13  8:24 [PATCH v5 0/6] Support ADIS16475 and similar IMUs Nuno Sá
2020-04-13  8:24 ` [PATCH v5 1/6] iio: imu: adis: Add Managed device functions Nuno Sá
2020-04-13  8:24 ` [PATCH v5 2/6] iio: imu: adis: Add irq flag variable Nuno Sá
2020-04-13  8:24 ` [PATCH v5 3/6] iio: adis: Add adis_update_bits() APIs Nuno Sá
2020-04-13  8:24 ` [PATCH v5 4/6] iio: adis: Support different burst sizes Nuno Sá
2020-04-13  8:24 ` [PATCH v5 5/6] iio: imu: Add support for adis16475 Nuno Sá
2020-04-27 18:06   ` Lars-Peter Clausen
2020-05-02 17:40     ` Jonathan Cameron
2020-05-02 18:01       ` Lars-Peter Clausen
2020-05-02 19:52         ` Nuno Sá
2020-05-03  8:47           ` Jonathan Cameron
2020-05-03  9:07             ` Lars-Peter Clausen
2020-05-03  9:12               ` Lars-Peter Clausen
2020-05-17 16:15                 ` Jonathan Cameron
2020-05-17 19:07                   ` Lars-Peter Clausen
2020-05-18 16:29                     ` Jonathan Cameron
2020-05-03 11:07               ` Nuno Sá
2020-05-03 11:29                 ` Jonathan Cameron
2020-05-03 17:19                   ` Jonathan Cameron
2020-05-03 17:55                     ` Nuno Sá
2020-04-13  8:24 ` [PATCH v5 6/6] dt-bindings: iio: Add adis16475 documentation Nuno Sá
2020-04-20 19:17   ` Rob Herring
2020-04-13 16:27 ` [PATCH v5 0/6] Support ADIS16475 and similar IMUs Jonathan Cameron
2020-04-25 15:18   ` Jonathan Cameron

Linux-IIO Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-iio/0 linux-iio/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-iio linux-iio/ https://lore.kernel.org/linux-iio \
		linux-iio@vger.kernel.org
	public-inbox-index linux-iio

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-iio


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git