Skip to content

Commit

Permalink
ad4880: add pyadi support
Browse files Browse the repository at this point in the history
Signed-off-by: Antoniu Miclaus <antoniu.miclaus@analog.com>
  • Loading branch information
amiclaus committed Mar 6, 2025
1 parent 80796c5 commit 4538af5
Show file tree
Hide file tree
Showing 9 changed files with 218 additions and 0 deletions.
1 change: 1 addition & 0 deletions adi/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
from adi.ad4170 import ad4170
from adi.ad4630 import ad4630, adaq42xx
from adi.ad4858 import ad4858
from adi.ad4880 import ad4880
from adi.ad5592r import ad5592r
from adi.ad5686 import ad5686
from adi.ad5754r import ad5754r
Expand Down
115 changes: 115 additions & 0 deletions adi/ad4880.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
# Copyright (C) 2022-2025 Analog Devices, Inc.
#
# SPDX short identifier: ADIBSD

from adi.attribute import attribute
from adi.context_manager import context_manager
from adi.rx_tx import rx


class ad4880(rx, context_manager):

""" AD4880 ADC """

_complex_data = False
channel = [] # type: ignore
_device_name = ""

def __init__(self, uri="", device_name="ad4880"):

"""Initialize."""
context_manager.__init__(self, uri, self._device_name)

compatible_part = "ad4880"
self._ctrl = None

if not device_name:
device_name = compatible_part
else:
if device_name != compatible_part:
raise Exception(f"Not a compatible device: {device_name}")

# Select the device matching device_name as working device
for device in self._ctx.devices:
if device.name == device_name:
self._ctrl = device
self._rxadc = device
break

if not self._ctrl:
raise Exception("Error in selecting matching device")

if not self._rxadc:
raise Exception("Error in selecting matching device")

self._rx_channel_names = []
self.channel = []
for ch in self._ctrl.channels:
name = ch._id
self._rx_channel_names.append(name)
self.channel.append(self._channel(self._ctrl, name))

rx.__init__(self)

class _channel(attribute):
def __init__(self, ctrl, channel_name):
self.name = channel_name
self._ctrl = ctrl

@property
def scale(self):
"""scale: Scale value"""
return self._get_iio_attr(self.name, "scale", False)

@property
def lvds_cnv(self):
"""scale: Scale value"""
return self._get_iio_attr(self.name, "lvds_cnv", False)

@lvds_cnv.setter
def lvds_cnv(self, calibscale):
""""""
self._set_iio_attr(self.name, "lvds_cnv", False, calibscale, self._ctrl)

@property
def lvds_sync(self):
""""""
return self._get_iio_attr(self.name, "lvds_sync", False)

@lvds_sync.setter
def calibscale(self, calibscale):
"""Set calibration scale value."""
self._set_iio_attr(self.name, "lvds_sync", False, calibscale, self._ctrl)

@property
def sampling_frequency(self):
"""sampling_frequency: Sampling frequency value"""
return self._get_iio_dev_attr("sampling_frequency", False)

@property
def sinc_dec_rate_available(self):
""""""
return self._get_iio_dev_attr("sinc_dec_rate_available", False)

@property
def sinc_dec_rate(self):
""""""
return self._get_iio_dev_attr("sinc_dec_rate", False)

@sinc_dec_rate.setter
def sinc_dec_rate(self, value):
self._set_iio_dev_attr("sinc_dec_rate", value)

@property
def filter_sel_available(self):
""""""
return self._get_iio_dev_attr_str("filter_sel_available", False)

@property
def filter_sel(self):
""""""
return self._get_iio_dev_attr_str("filter_sel", False)

@filter_sel.setter
def filter_sel(self, value):
self._set_iio_dev_attr_str("filter_sel", value)
7 changes: 7 additions & 0 deletions doc/source/devices/adi.ad4880.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ad4880
=================

.. automodule:: adi.ad4880
:members:
:undoc-members:
:show-inheritance:
1 change: 1 addition & 0 deletions doc/source/devices/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Supported Devices
adi.ad4170
adi.ad4630
adi.ad469x
adi.ad4880
adi.ad5592r
adi.ad5627
adi.ad5686
Expand Down
71 changes: 71 additions & 0 deletions examples/ad4880_example.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Copyright (C) 2025 Analog Devices, Inc.
#
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without modification,
# are permitted provided that the following conditions are met:
# - Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# - Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in
# the documentation and/or other materials provided with the
# distribution.
# - Neither the name of Analog Devices, Inc. nor the names of its
# contributors may be used to endorse or promote products derived
# from this software without specific prior written permission.
# - The use of this software may or may not infringe the patent rights
# of one or more patent holders. This license does not release you
# from the requirement that you obtain separate licenses from these
# patent holders to use this software.
# - Use of the software either in source or binary form, must be run
# on or directly connected to an Analog Devices Inc. component.
#
# THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
# INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A
# PARTICULAR PURPOSE ARE DISCLAIMED.
#
# IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, INTELLECTUAL PROPERTY
# RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
# BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
# THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

import sys

import matplotlib.pyplot as plt
import numpy as np
from adi import ad4880
from time import sleep

# Optionally pass URI as command line argument,
# else use default ip:analog.local
my_uri = sys.argv[1] if len(sys.argv) >= 2 else "ip:analog.local"
print("uri: " + str(my_uri))

my_adc = ad4880(uri=my_uri, device_name="ad4880")

my_adc.rx_enabled_channels = [0, 1]

print("Sampling frequency: ", my_adc.sampling_frequency)
# print("Test mode: ", my_adc.test_mode)
print("Scale: ", my_adc.channel[0].scale)
plt.clf()
sleep(0.5)
data = my_adc.rx()

# plt.plot(range(0, len(data)), data, label="channel0")
for i, d in enumerate(data):
plt.plot(d, label=my_adc._rx_channel_names[my_adc.rx_enabled_channels[i]])
plt.xlabel("Data Point")
plt.ylabel("ADC counts")
plt.legend(
bbox_to_anchor=(0.0, 1.02, 1.0, 0.102),
loc="lower left",
ncol=4,
mode="expand",
borderaxespad=0.0,
)

plt.show()
del my_adc
1 change: 1 addition & 0 deletions supported_parts.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
- AD4696
- AD4697
- AD4698
- AD4880
- AD5310R
- AD5311R
- AD5592R
Expand Down
2 changes: 2 additions & 0 deletions test/emu/devices/ad4880.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<?xml version="1.0" encoding="utf-8"?><!DOCTYPE context [<!ELEMENT context (device | context-attribute)*><!ELEMENT context-attribute EMPTY><!ELEMENT device (channel | attribute | debug-attribute | buffer-attribute)*><!ELEMENT channel (scan-element?, attribute*)><!ELEMENT attribute EMPTY><!ELEMENT scan-element EMPTY><!ELEMENT debug-attribute EMPTY><!ELEMENT buffer-attribute EMPTY><!ATTLIST context name CDATA #REQUIRED description CDATA #IMPLIED><!ATTLIST context-attribute name CDATA #REQUIRED value CDATA #REQUIRED><!ATTLIST device id CDATA #REQUIRED name CDATA #IMPLIED><!ATTLIST channel id CDATA #REQUIRED type (input|output) #REQUIRED name CDATA #IMPLIED><!ATTLIST scan-element index CDATA #REQUIRED format CDATA #REQUIRED scale CDATA #IMPLIED><!ATTLIST attribute name CDATA #REQUIRED filename CDATA #IMPLIED value CDATA #IMPLIED><!ATTLIST debug-attribute name CDATA #REQUIRED value CDATA #IMPLIED><!ATTLIST buffer-attribute name CDATA #REQUIRED value CDATA #IMPLIED>]><context name="network" description="10.48.65.248 Linux analog 6.1.0-271838-g69fc41f0840e-dirty #11 SMP PREEMPT Wed Jan 15 17:36:35 EET 2025 armv7l" ><context-attribute name="hdl_system_id" value="[ad488x_fmc_evb] on [zed] git branch [dev_ad4880] git [d3d3fc1afff25028fa728ee5f50e95d664c7ee31] dirty [2025-01-15 13:50:03] UTC" /><context-attribute name="hw_model" value="EVAL-AD4880-FMCZU1 on Xilinx Zynq ZED" /><context-attribute name="hw_carrier" value="Xilinx Zynq ZED" /><context-attribute name="hw_mezzanine" value="EVAL-AD4880-FMCZU1" /><context-attribute name="hw_name" value="EVAL-AD4880-FMCZ-U1" /><context-attribute name="hw_vendor" value="Analog Devices" /><context-attribute name="hw_serial" value="Empty Field" /><context-attribute name="local,kernel" value="6.1.0-271838-g69fc41f0840e-dirty" /><context-attribute name="uri" value="ip:10.48.65.248" /><context-attribute name="ip,ip-addr" value="10.48.65.248" /><device id="hwmon0" name="e000b000ethernetffffffff00" ><channel id="temp1" type="input" ><attribute name="crit" filename="temp1_crit" value="100000" /><attribute name="input" filename="temp1_input" value="41000" /><attribute name="max_alarm" filename="temp1_max_alarm" value="0" /></channel></device><device id="iio:device0" name="xadc" ><channel id="voltage5" name="vccoddr" type="input" ><attribute name="label" filename="in_voltage5_vccoddr_label" value="vccoddr" /><attribute name="raw" filename="in_voltage5_vccoddr_raw" value="2038" /><attribute name="scale" filename="in_voltage5_vccoddr_scale" value="0.732421875" /></channel><channel id="voltage0" name="vccint" type="input" ><attribute name="label" filename="in_voltage0_vccint_label" value="vccint" /><attribute name="raw" filename="in_voltage0_vccint_raw" value="1387" /><attribute name="scale" filename="in_voltage0_vccint_scale" value="0.732421875" /></channel><channel id="voltage4" name="vccpaux" type="input" ><attribute name="label" filename="in_voltage4_vccpaux_label" value="vccpaux" /><attribute name="raw" filename="in_voltage4_vccpaux_raw" value="2451" /><attribute name="scale" filename="in_voltage4_vccpaux_scale" value="0.732421875" /></channel><channel id="temp0" type="input" ><attribute name="offset" filename="in_temp0_offset" value="-2219" /><attribute name="raw" filename="in_temp0_raw" value="2626" /><attribute name="scale" filename="in_temp0_scale" value="123.040771484" /></channel><channel id="voltage7" name="vrefn" type="input" ><attribute name="label" filename="in_voltage7_vrefn_label" value="vrefn" /><attribute name="raw" filename="in_voltage7_vrefn_raw" value="5" /><attribute name="scale" filename="in_voltage7_vrefn_scale" value="0.732421875" /></channel><channel id="voltage1" name="vccaux" type="input" ><attribute name="label" filename="in_voltage1_vccaux_label" value="vccaux" /><attribute name="raw" filename="in_voltage1_vccaux_raw" value="2451" /><attribute name="scale" filename="in_voltage1_vccaux_scale" value="0.732421875" /></channel><channel id="voltage2" name="vccbram" type="input" ><attribute name="label" filename="in_voltage2_vccbram_label" value="vccbram" /><attribute name="raw" filename="in_voltage2_vccbram_raw" value="1391" /><attribute name="scale" filename="in_voltage2_vccbram_scale" value="0.732421875" /></channel><channel id="voltage3" name="vccpint" type="input" ><attribute name="label" filename="in_voltage3_vccpint_label" value="vccpint" /><attribute name="raw" filename="in_voltage3_vccpint_raw" value="1387" /><attribute name="scale" filename="in_voltage3_vccpint_scale" value="0.732421875" /></channel><channel id="voltage6" name="vrefp" type="input" ><attribute name="label" filename="in_voltage6_vrefp_label" value="vrefp" /><attribute name="raw" filename="in_voltage6_vrefp_raw" value="1713" /><attribute name="scale" filename="in_voltage6_vrefp_scale" value="0.732421875" /></channel><attribute name="sampling_frequency" value="961538" /><attribute name="waiting_for_supplier" value="0" /></device><device id="iio:device1" name="one-bit-adc-dac" ><channel id="voltage0" type="output" ><attribute name="label" filename="out_voltage0_label" value="SYNC_N" /><attribute name="raw" filename="out_voltage0_raw" value="0" /></channel><attribute name="waiting_for_supplier" value="0" /></device><device id="iio:device2" name="/axi/spi@e0007000/adf4350@1" ><channel id="altvoltage0" type="output" ><attribute name="frequency" filename="out_altvoltage0_frequency" value="400000000" /><attribute name="frequency_resolution" filename="out_altvoltage0_frequency_resolution" value="100000" /><attribute name="powerdown" filename="out_altvoltage0_powerdown" value="0" /><attribute name="refin_frequency" filename="out_altvoltage0_refin_frequency" value="25000000" /></channel><attribute name="waiting_for_supplier" value="0" /><debug-attribute name="direct_reg_access" value="0x400000" /></device><device id="iio:device3" name="ad9508" ><channel id="altvoltage3" name="CLK_A" type="output" ><attribute name="frequency" filename="out_altvoltage3_CLK_A_frequency" value="400000000" /><attribute name="label" filename="out_altvoltage3_CLK_A_label" value="CLK_A" /><attribute name="phase" filename="out_altvoltage3_CLK_A_phase" value="0.000000" /><attribute name="raw" filename="out_altvoltage3_CLK_A_raw" value="1" /></channel><channel id="altvoltage0" name="CNV_B" type="output" ><attribute name="frequency" filename="out_altvoltage0_CNV_B_frequency" value="40000000" /><attribute name="label" filename="out_altvoltage0_CNV_B_label" value="CNV_B" /><attribute name="phase" filename="out_altvoltage0_CNV_B_phase" value="0.000000" /><attribute name="raw" filename="out_altvoltage0_CNV_B_raw" value="1" /></channel><channel id="altvoltage1" name="CLK_B" type="output" ><attribute name="frequency" filename="out_altvoltage1_CLK_B_frequency" value="400000000" /><attribute name="label" filename="out_altvoltage1_CLK_B_label" value="CLK_B" /><attribute name="phase" filename="out_altvoltage1_CLK_B_phase" value="0.000000" /><attribute name="raw" filename="out_altvoltage1_CLK_B_raw" value="1" /></channel><channel id="altvoltage2" name="CNV_A" type="output" ><attribute name="frequency" filename="out_altvoltage2_CNV_A_frequency" value="40000000" /><attribute name="label" filename="out_altvoltage2_CNV_A_label" value="CNV_A" /><attribute name="phase" filename="out_altvoltage2_CNV_A_phase" value="0.000000" /><attribute name="raw" filename="out_altvoltage2_CNV_A_raw" value="1" /></channel><attribute name="sync_dividers" value="ERROR" /><attribute name="waiting_for_supplier" value="0" /><debug-attribute name="direct_reg_access" value="0x81" /></device><device id="iio:device6" name="ad4880" ><channel id="voltage0" type="input" ><scan-element index="0" format="le:S20/32&gt;&gt;0" scale="0.000006" /><attribute name="lvds_cnv" filename="in_voltage0_lvds_cnv" value="1" /><attribute name="lvds_sync" filename="in_voltage0_lvds_sync" value="enable" /><attribute name="scale" filename="in_voltage0_scale" value="0.000005722" /></channel><channel id="voltage1" type="input" ><scan-element index="1" format="le:S20/32&gt;&gt;0" scale="0.000006" /><attribute name="lvds_cnv" filename="in_voltage1_lvds_cnv" value="1" /><attribute name="lvds_sync" filename="in_voltage1_lvds_sync" value="enable" /><attribute name="scale" filename="in_voltage1_scale" value="0.000005722" /></channel><attribute name="filter_sel" value="disabled" /><attribute name="filter_sel_available" value="disabled sinc1 sinc5 sinc5_plus_compensation" /><attribute name="sampling_frequency" value="40000000" /><attribute name="sinc_dec_rate" value="2" /><attribute name="sinc_dec_rate_available" value="2 4 8 16 32 64 128 256 512 1024" /><attribute name="sync_start_enable" value="disarm" /><attribute name="sync_start_enable_available" value="arm" /><attribute name="waiting_for_supplier" value="0" /><buffer-attribute name="data_available" value="0" /><buffer-attribute name="direction" value="in" /><buffer-attribute name="length_align_bytes" value="8" /><debug-attribute name="pseudorandom_err_check" value="CH0 : PN9 : In Sync : OK" /><debug-attribute name="direct_reg_access" value="0x10" /></device><device id="iio:device7" name="ad4880_chb" ><channel id="voltage0" type="input" ><attribute name="lvds_cnv" filename="in_voltage0_lvds_cnv" value="1" /><attribute name="lvds_sync" filename="in_voltage0_lvds_sync" value="enable" /><attribute name="scale" filename="in_voltage0_scale" value="0.000005722" /></channel><channel id="voltage1" type="input" ><attribute name="lvds_cnv" filename="in_voltage1_lvds_cnv" value="1" /><attribute name="lvds_sync" filename="in_voltage1_lvds_sync" value="enable" /><attribute name="scale" filename="in_voltage1_scale" value="0.000005722" /></channel><attribute name="filter_sel" value="disabled" /><attribute name="filter_sel_available" value="disabled sinc1 sinc5 sinc5_plus_compensation" /><attribute name="sampling_frequency" value="40000000" /><attribute name="sinc_dec_rate" value="2" /><attribute name="sinc_dec_rate_available" value="2 4 8 16 32 64 128 256 512 1024" /><attribute name="sync_start_enable" value="disarm" /><attribute name="sync_start_enable_available" value="arm" /><attribute name="waiting_for_supplier" value="0" /><debug-attribute name="pseudorandom_err_check" value="CH0 : PN9 : In Sync : OK
CH1 : UNDEF : In Sync : PN Error" /><debug-attribute name="direct_reg_access" value="0x10" /></device><device id="iio_sysfs_trigger" ><attribute name="add_trigger" value="ERROR" /><attribute name="remove_trigger" value="ERROR" /></device></context>
8 changes: 8 additions & 0 deletions test/emu/hardware_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -703,3 +703,11 @@ ad738x:
- data_devices:
- iio:device0

ad4080:
- ad4080
- pyadi_iio_class_support:
- ad4080
- emulate:
- filename: ad4080.xml
- data_devices:
- iio:device6
12 changes: 12 additions & 0 deletions test/test_ad4880.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import pytest

hardware = ["ad4880"]
classname = ["adi.ad4880"]


#########################################
@pytest.mark.iio_hardware(hardware, True)
@pytest.mark.parametrize("classname", [(classname)])
@pytest.mark.parametrize("channel", [0, 1])
def test_ad4880_rx_data(test_dma_rx, iio_uri, classname, channel):
test_dma_rx(iio_uri, classname, channel)

0 comments on commit 4538af5

Please sign in to comment.