Skip to contentSkip to conversation

NXP SAR ADC IIO driver for s32g2/3 platforms

PATCH Superseded Daniel Lezcano 2 participants 4 messages Nov 19, 2025

Subsystems (2)

v7 of 9 Superseded Latest is v9 →

lore
Share & tools
lore
#0 lore raw

v7 cover NXP SAR ADC IIO driver for s32g2/3 platforms

The S32G2 and S32G3 platforms have a couple of successive approximation register (SAR) ADCs with eight channels and 12-bit resolution. These changes provide the driver support for these ADCs and the bindings describing them.

The driver is derived from the BSP driver version. It has been partly rewritten to conform to upstream criteria.

https://github.com/nxp-auto-linux/linux/blob/release/bsp44.0-6.6.85-rt/drivers/iio/adc/s32cc_adc.c

After the V1 posting there were some discussions around the DMA code to be converted to use the IIO DMA API [1]. Unfortunately this one is not yet fully implemented and merged in the framework to support the cyclic DMA. The current DMA code in the driver has been used in production since several years and even if I agree it can be improved with a dedicated IIO DMA API in the future, IMO, it sounds reasonable to keep it as is until the IIO DMA API supporting the cyclic DMA is merged. I'll be glad to convert the driver code if such an API exists and allows to remove code inside the driver.

[1] https://lore.kernel.org/all/[email protected]/
[2] https://lore.kernel.org/all/[email protected]/

Changelog:
* V7:
** Andy Shevchenko **
- Moved paragraph closer to the tags in the changelog
- Used Originally-by which is more adequate
- Removed unneeded modulo conversion in macro
- Fixed the consistency of the style by lowercasing the hexa value
- Rename a timeout macro and remove another one
- Clarified a comment when getting the power state of the ADC
- Added a comment to clarify the clock is fast and suitable in atomic context
- Uppercased the 'adc' words
- Added a TODO to use field_get() when available
- Removed unneeded explicit casting
- Replaced a more readable version with raw ? 0 : 1
- Folded return value check with wait_for_completion_interruptible()
- Fixed comment "8 bits" --> "8-bit"
- Fixed typo in comment
- Fixed comment "iio_push_to_buffers_with_ts()"
- Clarified why not using a pointer to a mask
- Removed unneeded blank line
- Removed duplicate error code in message
- Initialized the spin lock before requesting the interrupt
- One lined declaration in suspend/resume callbacks
- Added trailing comma in structure initialization

* V6:
** Vinod Koul **
- Dynamically allocate/release the channel at enable/disable

** Jonathan Cameron **
- Reached out Vinod to clarify the buffer life cycle
- Inverted more intuitive variable initialization
- Updated comment with "iio_push_to_buffers_with_ts"

** Andy Shevchenko **
- Removed unused NXP_SAR_ADC_IIO_BUFF_SZ macro
- Removed "<litteral>U" annotation
- Checked the buffer is a byte buffer
- Investigated callback routine vs residue and updated the changelog the conclusions [2]

* V5:
- Rebased against v6.18-rc1

** Jonathan Cameron **
- Replace DRIVER_NAME macro with its literal string
- Used FIELD_MODIFY() wherever it is possible
- Complied with the 80 chars convention
- Combined two variables in a single line declaration
- Removed the 'remove' function as it is useless
- Changed s32g2_sar_adc_data structure indentation / format

* V4:
** Christophe Jaillet **
- Used dmam_alloc_coherent() instead of dma_alloc_coherent()

* V3:
** Jonathan Cameron **
- Removed specific IIO_SYSFS_TRIGGER dependency in Kconfig
- Fixed headers
- Avoided macro generic names
- Used IIO_DECLARE_BUFFER_WITH_TS
- Documented buffer and buffer_chan
- Fixed single line comment
- Commented why channel 32 is the timestamp
- Renamed __<prefixed> functions
- Factored out the raw read function to prevent nested goto in the switch
- Returned -EINVAL instead of break
- Removed explict pointer cast
- Used iio_push_to_buffers_with_ts variant
- Fixed ordering operations in postenable / predisable
- Return IRQ_HANDLED even if there is an error in the isr
- Fixed devm_add_action_or_reset() to return directly
- Used sizeof(*var) instead of sizeof(struct myvar)
- Used model name instead of dev_name()
- Used dev_err_probe() in any case in the probe function
- Fixed indentation

** David Lechner **
- Kept alphabetical order in Makefile
- Changed explicit GPL-2.0-only
- Removed clock name in when calling devm_clk_get_enabled()

** Andriy Shevchenko **
- Fixed headers ordering and added the missing ones
- Fixed constant numeric format
- Ran pahole and consolidated the nxp_sar_adc structure
- Fixed semi-column in comments and typos
- Fixed indentation
- Moved data assignment before iio_dev allocation

* V2:
- Massaged the cover letter changelog to explain the DMA ** Andriy Shevchenko **
- Added missing headers and use proper header for of.h
- Changed macro offset zero to be consistent
- Remove macros REG_ADC_MCR_NRSMPL_* as they are unused
- Changed delays macro under the form 100000 => 100 * USEC_PER_MSEC
- Replaced PAGE_SIZE by a NXP_PAGE_SIZE = SZ_4K macro
- Replaced read_poll_timeout() by readl_poll_timeout()
- Changed error pattern "error first"
- Replaced variable type 'int' to 'unsigned int'
- Fixed bug right instead of left shift, use BIT(channel)
- Returned directly from switch-case
- Used guard(spinlock_irqsave)()
- One liner function call
- Remove redundant {}
- Write default values litterals instead of temporary variables
- Changed variable name vref -> vref_mV
- Removed unneeded error message
- Used dev_err_probe() consistently
- Removed successful driver probe message
- Removed redundant blank line

** Nuno Sa **
- Replaced of_device_get_match_data() by device_get_match_data()
- Removed iio_device_unregister() because devm_iio_device_register() is used
- Removed "/* sentinel */" comment
- Removed CONFIG_PM_SLEEP defiries

** Krzysztof Kozlowski / David Lechner **
- Removed clock-names in DT bindings
- Fixed minItems by maxItems

* V1:
- Initial post

Daniel Lezcano (2):
dt-bindings: iio: adc: Add the NXP SAR ADC for s32g2/3 platforms
iio: adc: Add the NXP SAR ADC support for the s32g2/3 platforms

 .../bindings/iio/adc/nxp,s32g2-sar-adc.yaml   |   63 +
 drivers/iio/adc/Kconfig                       |   12 +
 drivers/iio/adc/Makefile                      |    1 +
 drivers/iio/adc/nxp-sar-adc.c                 | 1015 +++++++++++++++++
 4 files changed, 1091 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/adc/nxp,s32g2-sar-adc.yaml
 create mode 100644 drivers/iio/adc/nxp-sar-adc.c
Signature · 1 line
2.43.0
#1 lore raw

PATCH v7 1/2 dt-bindings: iio: adc: Add the NXP SAR ADC for s32g2/3 platforms

The s32g2 and s32g3 NXP platforms have two instances of a Successive Approximation Register ADC. It supports the raw, trigger and scan modes which involves the DMA. Add their descriptions.

---
 .../bindings/iio/adc/nxp,s32g2-sar-adc.yaml   | 63 +++++++++++++++++++
 1 file changed, 63 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/adc/nxp,s32g2-sar-adc.yaml
Documentation/devicetree/bindings/iio/adc/nxp,s32g2-sar-adc.yaml new file +63 -0
new file mode 100644
index 000000000000..ec258f224df8
@@ -0,0 +1,63 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/adc/nxp,s32g2-sar-adc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: NXP Successive Approximation ADC
+
+description:
+  The NXP SAR ADC provides fast and accurate analog-to-digital
+  conversion using the Successive Approximation Register (SAR) method.
+  It has 12-bit resolution with 8 input channels. Conversions can be
+  launched in software or using hardware triggers. It supports
+  continuous and one-shot modes with separate registers.
+
+maintainers:
+  - Daniel Lezcano <[email protected]>
+
+properties:
+  compatible:
+    oneOf:
+      - const: nxp,s32g2-sar-adc
+      - items:
+          - const: nxp,s32g3-sar-adc
+          - const: nxp,s32g2-sar-adc
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  dmas:
+    maxItems: 1
+
+  dma-names:
+    const: rx
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - clocks
+  - dmas
+  - dma-names
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+
+    adc@401f8000 {
+        compatible = "nxp,s32g2-sar-adc";
+        reg = <0x401f8000 0x1000>;
+        interrupts = <GIC_SPI 70 IRQ_TYPE_LEVEL_HIGH>;
+        clocks = <&clks 0x41>;
+        dmas = <&edma0 0 32>;
+        dma-names = "rx";
+    };
Signature · 1 line
2.43.0
#2 lore raw

PATCH v7 2/2 iio: adc: Add the NXP SAR ADC support for the s32g2/3 platforms

In reply to Daniel Lezcano

The NXP S32G2 and S32G3 platforms integrate a successive approximation register (SAR) ADC. Two instances are available, each providing 8 multiplexed input channels with 12-bit resolution. The conversion rate is up to 1 Msps depending on the configuration and sampling window.

The SAR ADC supports raw, buffer, and trigger modes. It can operate in both single-shot and continuous conversion modes, with optional hardware triggering through the cross-trigger unit (CTU) or external events. An internal prescaler allows adjusting the sampling clock, while per-channel programmable sampling times provide fine-grained trade-offs between accuracy and latency. Automatic calibration is performed at probe time to minimize offset and gain errors.

All modes have been validated on the S32G274-RDB2 platform using an externally generated square wave captured by the ADC. Tests covered buffered streaming via IIO, trigger synchronization, and accuracy verification against a precision laboratory signal source.

One potential scenario, not detected during testing, is that in some corner cases the DMA may already have been armed for the next transfer, which can lead dmaengine_tx_status() to return an incorrect residue. The callback_result() operation—intended to supply the residue directly and eliminate the need to call dmaengine_tx_status()—also does not work. Attempting to use dmaengine_pause() and dmaengine_resume() to prevent the residue from being updated does not work either.

This potential scenario should apply to any driver using cyclic DMA. However, no current driver actually handles this case, and they all rely on the same acquisition routine (e.g., the STM32 implementation). The NXP SAR acquisition routine has been used in production for several years, which is a good indication of its robustness.

As the IIO is implementing the cyclic DMA support API, it is not worth to do more spins to the current routine as it will go away when the new API will be available.

The driver is derived from the BSP implementation and has been partly rewritten to comply with upstream requirements. For this reason, all contributors are listed as co-developers.

---
 drivers/iio/adc/Kconfig       |   12 +
 drivers/iio/adc/Makefile      |    1 +
 drivers/iio/adc/nxp-sar-adc.c | 1015 +++++++++++++++++++++++++++++++++
 3 files changed, 1028 insertions(+)
 create mode 100644 drivers/iio/adc/nxp-sar-adc.c
drivers/iio/adc/Kconfig +12 -0
index 58a14e6833f6..363eb8a3a6f2 100644
@@ -1212,6 +1212,18 @@ config NPCM_ADC
 	  This driver can also be built as a module. If so, the module
 	  will be called npcm_adc.
 
+config NXP_SAR_ADC
+	tristate "NXP S32G SAR-ADC driver"
+	depends on ARCH_S32 || COMPILE_TEST
+	select IIO_BUFFER
+	select IIO_TRIGGERED_BUFFER
+	help
+	  Say yes here to build support for S32G platforms
+	  analog-to-digital converter.
+
+	  This driver can also be built as a module. If so, the module will be
+	  called nxp_sar_adc.
+
 config PAC1921
 	tristate "Microchip Technology PAC1921 driver"
 	depends on I2C
drivers/iio/adc/Makefile +1 -0
index d008f78dc010..c9d5bc976fd3 100644
@@ -107,6 +107,7 @@ obj-$(CONFIG_MXS_LRADC_ADC) += mxs-lradc-adc.o
 obj-$(CONFIG_NAU7802) += nau7802.o
 obj-$(CONFIG_NCT7201) += nct7201.o
 obj-$(CONFIG_NPCM_ADC) += npcm_adc.o
+obj-$(CONFIG_NXP_SAR_ADC) += nxp-sar-adc.o
 obj-$(CONFIG_PAC1921) += pac1921.o
 obj-$(CONFIG_PAC1934) += pac1934.o
 obj-$(CONFIG_PALMAS_GPADC) += palmas_gpadc.o
drivers/iio/adc/nxp-sar-adc.c new file +1015 -0

1,015 lines not on this page · raw message

Signature · 1 line
2.43.0
Reviewed-by on v7 2/2
#3 lore raw

Re: [PATCH v7 2/2] iio: adc: Add the NXP SAR ADC support for the s32g2/3 platforms

Quoted 33 lines · Daniel Lezcano

The NXP S32G2 and S32G3 platforms integrate a successive approximation register (SAR) ADC. Two instances are available, each providing 8 multiplexed input channels with 12-bit resolution. The conversion rate is up to 1 Msps depending on the configuration and sampling window.

The SAR ADC supports raw, buffer, and trigger modes. It can operate in both single-shot and continuous conversion modes, with optional hardware triggering through the cross-trigger unit (CTU) or external events. An internal prescaler allows adjusting the sampling clock, while per-channel programmable sampling times provide fine-grained trade-offs between accuracy and latency. Automatic calibration is performed at probe time to minimize offset and gain errors.

All modes have been validated on the S32G274-RDB2 platform using an externally generated square wave captured by the ADC. Tests covered buffered streaming via IIO, trigger synchronization, and accuracy verification against a precision laboratory signal source.

One potential scenario, not detected during testing, is that in some corner cases the DMA may already have been armed for the next transfer, which can lead dmaengine_tx_status() to return an incorrect residue. The callback_result() operation—intended to supply the residue directly and eliminate the need to call dmaengine_tx_status()—also does not work. Attempting to use dmaengine_pause() and dmaengine_resume() to prevent the residue from being updated does not work either.

This potential scenario should apply to any driver using cyclic DMA. However, no current driver actually handles this case, and they all rely on the same acquisition routine (e.g., the STM32 implementation). The NXP SAR acquisition routine has been used in production for several years, which is a good indication of its robustness.

Quoted 7 lines

As the IIO is implementing the cyclic DMA support API, it is not worth to do more spins to the current routine as it will go away when the new API will be available.

The driver is derived from the BSP implementation and has been partly rewritten to comply with upstream requirements. For this reason, all contributors are listed as co-developers.

...contributors to the original code are...

This version is good enough, only a couple of nit-picks most important of which is PM related macros usage.

...

Quoted 19 lines
drivers/iio/adc/nxp-sar-adc.c new file +19 -0
+static int nxp_sar_adc_probe(struct platform_device *pdev)
+{
+	struct device *dev = &pdev->dev;
+	const struct nxp_sar_adc_data *data = device_get_match_data(dev);
+	struct nxp_sar_adc *info;
+	struct iio_dev *indio_dev;
+	struct resource *mem;
+	int irq, ret;
+
+	indio_dev = devm_iio_device_alloc(dev, sizeof(*info));
+	if (!indio_dev)
+		return -ENOMEM;
+
+	info = iio_priv(indio_dev);
+	info->vref_mV = data->vref_mV;
+	spin_lock_init(&info->lock);
+	info->regs = devm_platform_get_and_ioremap_resource(pdev, 0, &mem);
+	if (IS_ERR(info->regs))
+		return dev_err_probe(dev, PTR_ERR(info->regs),

drivers/iio/adc/nxp-sar-adc.c line 918

Quoted 10 lines
drivers/iio/adc/nxp-sar-adc.c new file +9 -0
+				     "failed to get and remap resource");
+
+	info->regs_phys = mem->start;
+
+	irq = platform_get_irq(pdev, 0);
+	if (irq < 0)
+		return irq;
 
+	ret = devm_request_irq(dev, irq, nxp_sar_adc_isr, 0,
+			       dev_name(dev), indio_dev);

At least dev_name(dev) can be placed on the previous line.

Quoted 13 lines
drivers/iio/adc/nxp-sar-adc.c new file +13 -0
+	if (ret < 0)
+		return ret;
+
+	info->clk = devm_clk_get_enabled(dev, NULL);
+	if (IS_ERR(info->clk))
+		return dev_err_probe(dev, PTR_ERR(info->clk),
+				     "failed to get the clock\n");
+
+	platform_set_drvdata(pdev, indio_dev);
+
+	init_completion(&info->completion);
+
+	indio_dev->name = data->model;

drivers/iio/adc/nxp-sar-adc.c line 941

Quoted 10 lines
drivers/iio/adc/nxp-sar-adc.c new file +10 -0
+	indio_dev->info = &nxp_sar_adc_iio_info;
+	indio_dev->modes = INDIO_DIRECT_MODE | INDIO_BUFFER_SOFTWARE;
+	indio_dev->channels = nxp_sar_adc_iio_channels;
+	indio_dev->num_channels = ARRAY_SIZE(nxp_sar_adc_iio_channels);
+
+	nxp_sar_adc_set_default_values(info);
+
+	ret = nxp_sar_adc_calibration(info);
+	if (ret)
+		dev_err_probe(dev, ret, "Calibration failed\n");

Some of the messages started with capital letter, some with a small. Please, make them consistent with whatever style you choose.

drivers/iio/adc/nxp-sar-adc.c line 945

Quoted 3 lines
drivers/iio/adc/nxp-sar-adc.c new file +3 -0
+	ret = nxp_sar_adc_dma_probe(dev, info);
+	if (ret)
+		return dev_err_probe(dev, ret, "Failed to initialize the dma\n");

DMA

Quoted 13 lines
drivers/iio/adc/nxp-sar-adc.c new file +13 -0
+	ret = devm_iio_triggered_buffer_setup(dev, indio_dev,
+					      &iio_pollfunc_store_time,
+					      &nxp_sar_adc_trigger_handler,
+					      &iio_triggered_buffer_setup_ops);
+	if (ret < 0)
+		return dev_err_probe(dev, ret, "Couldn't initialise the buffer\n");
+
+	ret = devm_iio_device_register(dev, indio_dev);
+	if (ret)
+		return dev_err_probe(dev, ret, "Couldn't register the device\n");
+
+	return 0;
+}

...

Quoted 1 line

+static SIMPLE_DEV_PM_OPS(nxp_sar_adc_pm_ops, nxp_sar_adc_suspend, nxp_sar_adc_resume);

include/linux/pm.h:

/* Deprecated. Use DEFINE_SIMPLE_DEV_PM_OPS() instead. */

...

drivers/iio/adc/nxp-sar-adc.c line 1008

Quoted 6 lines
drivers/iio/adc/nxp-sar-adc.c new file +6 -0
+static struct platform_driver nxp_sar_adc_driver = {
+	.probe = nxp_sar_adc_probe,
+	.driver = {
+		.name = "nxp-sar-adc",
+		.of_match_table = nxp_sar_adc_match,
+		.pm = pm_ptr(&nxp_sar_adc_pm_ops),

Shouldn't this be pm_sleep_ptr()?

Quoted 2 lines
drivers/iio/adc/nxp-sar-adc.c new file +2 -0
+	},
+};
Signature · 2 lines
With Best Regards,
Andy Shevchenko