Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for AD4052 ADC Family #2642

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add support for AD4052 ADC Family #2642

wants to merge 4 commits into from

Conversation

gastmaier
Copy link

@gastmaier gastmaier commented Nov 1, 2024

PR Description

Add:

  • driver support for D4052/AD4058/AD4050/AD4056 (16-bit/12-bit SAR ADC SPI)
  • devicetree binding

Optional:

  • sample devicetree for coraz7s
  • kconfig imply driver

Features:

  • Single shot using gpio as ADC CNV
  • Buffer readings using AXI PWM ADC CNV and ADC GP1 Data Ready as AXI SPI Engine Offload Trigger
  • Monitor mode with ADC GP0 as interrupt trigger (either IIO threshold direction event)
    • User should do register access to get event details.
  • Functional modes via oversampling config: Sample Mode (0/1) or Burst Averaging Mode (>1)
    • Burst Avg enables configuring averaging filter length value (AVG_CONFIG.AVG_WIN_LEN)
  • DEVICE_CONFIG.POWER_MODE : put device on sleep at pm_runtime ops.
  • TIMER_CONFIG.FS_BURST_AUTO : configure burst avg enable and trigger mode sample rates via channel sampling frequency config.

Overall, the highlight of this device is the monitor capability, leveraged by the autonomous trigger mode and exposed as IIO Event.

Linux driver doc:

HDL: analogdevicesinc/hdl#1504
Datasheet: www.analog.com/ad4052
Tested on Coraz7s

PR Type

  • Bug fix (a change that fixes an issue)
  • New feature (a change that adds new functionality)
  • Breaking change (a change that affects other repos or cause CIs to fail)

PR Checklist

  • I have conducted a self-review of my own code changes
  • I have tested the changes on the relevant hardware
  • I have updated the documentation outside this repo accordingly (if there is the case)

@gastmaier
Copy link
Author

gastmaier commented Nov 4, 2024

Forced pushed to:

  • Add support to TIMER_CONFIG.FS_BURST_AUTO
  • Only write GP during probe.
  • Simplify IRQ Handler, leave to the user to clear the irq, because:
    • Entering config mode causes the irq to unset.
    • Re-entering monitor mode sets the irq back if still outside the threshold range, causing new handler calls.
    • "Ignoring next interrupt" would generate obnoxious logic.

Forced pushed (2) to:

  • Invert fs_burst_auto array entries, default all devices to 2MSPS (Yes, this value is -EINVAL for ad4056/ad4058, but is the datasheet reset value)

Forced pushed (3) to:

  • Clean-up unused enums.
  • Rename ad405x to ad4052 in the dts

@gastmaier gastmaier force-pushed the staging/ad4052 branch 3 times, most recently from 1f5b827 to 9611c42 Compare November 6, 2024 19:03
Copy link
Collaborator

@nunojsa nunojsa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here it goes first round of review...

I think this one can be upstreamed without the offload bits

Documentation/devicetree/bindings/iio/adc/adi,ad4052.yaml Outdated Show resolved Hide resolved
Documentation/devicetree/bindings/iio/adc/adi,ad4052.yaml Outdated Show resolved Hide resolved
Documentation/devicetree/bindings/iio/adc/adi,ad4052.yaml Outdated Show resolved Hide resolved
Documentation/devicetree/bindings/iio/adc/adi,ad4052.yaml Outdated Show resolved Hide resolved
Documentation/devicetree/bindings/iio/adc/adi,ad4052.yaml Outdated Show resolved Hide resolved
drivers/iio/adc/ad4052.c Outdated Show resolved Hide resolved
drivers/iio/adc/ad4052.c Outdated Show resolved Hide resolved
drivers/iio/adc/ad4052.c Show resolved Hide resolved
drivers/iio/adc/ad4052.c Outdated Show resolved Hide resolved
drivers/iio/adc/ad4052.c Outdated Show resolved Hide resolved
gastmaier

This comment was marked as duplicate.

@gastmaier gastmaier force-pushed the staging/ad4052 branch 2 times, most recently from 4b81da9 to 494d89f Compare November 12, 2024 00:15
@gastmaier
Copy link
Author

gastmaier commented Nov 12, 2024

Change log v0 -> v1

Review changes:

  • Move functional modes from devicetree entry to different OVERSAMPLING_RATIO values, affecting RAW read and buffered.
  • Documentation YAML fixes, removal of functional mode.
  • Header on alphabetical order.
  • Use field_prep
  • Remove forward declaration, reorder methods instead.
  • Fix cache line aligment.
  • Use devm runtime enable, remove manual remove.
  • Use dev_err_probe
  • General Documentation/.yaml fixes
  • Make all regmap_bulk dma safe.
  • Remove/simplify switch cases where not needed.
  • Instead of using of_node, use spi->irq directly
  • Use regmap update bits.
  • Use fsleep
  • Use oversampling iio property (value 0 is invalid, 1 put on Sample Mode, > 1 Burst Averaging mode)

New:

  • Add regmap access tables

Design changes:

  • Under IIO Event thrshold enabled (device Monitor Mode), return device access busy for every other access, simplifying logic by not requiring exiting and re-entering mode and having an obscure "monitoring downtime" during access.
  • Use oversampling iio prop instead of devicetree entry to switch functional modes.

Documentation/devicetree/bindings/iio/adc/adi,ad4052.yaml Outdated Show resolved Hide resolved
tristate "Analog Devices AD4052 Driver"
depends on SPI
depends on PWM
depends on GPIOLIB
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm also not sure if gpio is something you should depend on or just select it. I think the single shot reading could be something useful to have even more to make this driver more upstreamable without offload support (we can still some questions about it though).

tristate "Analog Devices AD4052 Driver"
depends on SPI
depends on PWM
depends on GPIOLIB
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also one not on the commit message. Style is iio: adc: .... Drop the drivers:

drivers/iio/adc/ad4052.c Show resolved Hide resolved
drivers/iio/adc/ad4052.c Outdated Show resolved Hide resolved
drivers/iio/adc/ad4052.c Outdated Show resolved Hide resolved
drivers/iio/adc/ad4052.c Outdated Show resolved Hide resolved
if (val == 0) {
st->mode = AD4052_SAMPLE_MODE;
} else {
st->mode = AD4052_BURST_AVERAGING_MODE;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would double check other examples of oversampling. To me this is a 1 or 0 thing. Either it's enabled it not. Your mode variable also just seems to have two states here so the way you're handling val raises some questions.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The device supports from 2 to 4096 in powers of 2 samples for avg mode.
Decided to reserve 0 and 1 to disable the feature (return to sample mode)

@gastmaier
Copy link
Author

gastmaier commented Nov 17, 2024

Change log v1 -> v2

Review changes:

  • Include all peripheral properties
  • Drop cnv-gpio description
  • Updated dt-binding commit description
  • Replace d32 array by d16/d32 union (requires ignoring misleading checkpatch warning).
  • Remove MODULE_IMPORT_NS(IIO_AD4052);
  • Add error handling where missing
  • remove {} in single statement ifs, coherent style
  • Use multiple scan masks for changing precision due to oversampling
  • Move all if (st->mode == AD4052_MONITOR_MODE) inside the IIO mutex claim.
  • Drop switches where there is only one channel/event type
  • Remove unused AD4052_AVERAGING_MODE (would require a timed trigger) and AD4052_CONFIG_MODE (implicit mode outside any reading)
  • ad4052_set_avg_filter pass st directly.
  • Use different variables instead of the array for the chip_info

Changes:

  • Use GPIO interrupt instead of PS IRQ
  • All GPIOs are optional, does not require GPIO on KConfig. The user shall bring his own external trigger or short the CS and CNV, for example.
  • Move PWM sampling rate to IIO_ATTR
  • Move ext fs_burst_auto to channel sampling freq
  • Use Data Ready assertions for single shot readings, timeout after 1 second

Extra force push to resolve merge conflict

@gastmaier
Copy link
Author

Change log v2 -> v3

  • Add "0" (disabled) to oversampling avail list
  • Update iic controller dts address

@nunojsa
Copy link
Collaborator

nunojsa commented Nov 29, 2024

Change log v2 -> v3

This is not forgotten... I'll try to check it Monday

Add dt-bindings for AD4052 family, devices AD4050/AD4052/AD4056/AD4058,
low-power with monitor capabilities SAR ADCs.
Contain selectable oversampling and sample rate, the latter for both
oversampling and monitor mode.
The monitor capability is exposed as an IIO threshold either direction
event.

Signed-off-by: Jorge Marques <[email protected]>
The AD4052 CNV pin is driven by a GPIO for single shot readings and
by a PWM for buffer readings.
The functional-mode entry allows to set Sample Mode (0) or Burst
Averaging Mode (1).
During runtime, it is possible to enter Trigger Mode through IIO Events.

Signed-off-by: Jorge Marques <[email protected]>
The AD4052/AD4058/AD4050/AD4056 are versatile, 16-bit/12-bit,
successive approximation register (SAR) analog-to-digital converter (ADC)
that enables low-power, high-density data acquisition solutions without
sacrificing precision.
This ADC offers a unique balance of performance and power efficiency,
plus innovative features for seamlessly switching between high-resolution
and low-power modes tailored to the immediate needs of the system.
The AD4052/AD4058/AD4050/AD4056 are ideal for battery-powered,
compact data acquisition and edge sensing applications.

Signed-off-by: Jorge Marques <[email protected]>
Add entry for the AD4052 ADC family driver.

Signed-off-by: Jorge Marques <[email protected]>
@gastmaier
Copy link
Author

Force pushed to resolve merge conflicts due to main rebase.
(minor drivers/iio/adc/Kconfig drivers/iio/adc/Makefile entries )
Then checked with git diff public/main..@

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants