This version is outdated by a newer approved version.
This version (28 May 2019 11:25) was approved by Michael Hennerich.The Previously approved version (12 Apr 2019 17:08) is available.
This version (28 May 2019 11:25) was approved by Michael Hennerich.The Previously approved version (12 Apr 2019 17:08) is available.This is an old revision of the document!
Table of Contents
AD9172 DAC Linux Driver
This driver is used in conjunction with the AXI DAC HDL Linux Driver
Supported Devices
Supported Boards
This driver supports the
Supported HDL Cores
Description
The AD9172 is a high performance, dual, 16-bit digital-to-analog converter (DAC) that supports DAC sample rates to 12.6 GSPS. The device features an 8-lane, 15 Gbps JESD204B data input port, a high performance, on-chip DAC clock multiplier, and digital signal processing capabilities targeted at single-band and multiband direct to radio frequency (RF) wireless applications.
The AD9172 features three complex data input channels per RF DAC that are bypassable. Each data input channel includes a configurable gain stage, an interpolation filter, and a channel numerically controlled oscillator (NCO) for flexible, multiband frequency planning. The device supports up to a 1.5 GSPS complex data rate per input channel and is capable of aggregating multiple complex input data streams up to a maximum complex data rate of 1.5 GSPS. Additionally, the AD9172 supports ultrawide bandwidth modes bypassing the channelizers to provide maximum data rates of up to 3.08 GSPS (with 16-bit resolution) and 4.1 GSPS (with 12-bit resolution).
Source Code
Status
| Source | Mainlined? |
|---|---|
| drivers/iio/frequency/ad9172.c | WIP |
Files
| Function | File |
|---|---|
| driver | drivers/iio/frequency/ad9172.c |
| API driver | drivers/iio/frequency/ad917x |
| driver | drivers/iio/frequency/cf_axi_dds.c |
| driver | drivers/iio/frequency/cf_axi_dds_buffer_stream.c |
| include | drivers/iio/frequency/cf_axi_dds.h |
| Documentation | adi,ad9172.txt |
Example device trees
Example platform device initialization
The AD9172 driver is a SPI bus driver and can be instantiated via device tree.
Required properties:
- compatible: Should always be one of these:
- “adi,ad9171”
- “adi,ad9172”
- “adi,ad9173”
- “adi,ad9174”
- “adi,ad9175”
- “adi,ad9176”
- reg: SPI chip select number.
- spi-max-frequency: Max SPI frequency to use (⇐ 10000000).
- clocks: a list of phandle, one for each entry in clock-names.
- clock-names: Must include the following entries: “jesd_dac_clk”, “dac_clk”, “dac_sysref”
- adi,dac-rate-khz: The desired DAC rate in kHz
- adi,jesd-link-mode: The desired JESD204 Link Mode, please refer to the AD917x datasheet.
- adi,dac-interpolation: The DAC or main datapath interpolation, please refer to the supported values for a given Link Mode in the AD917x datasheet.
- adi,channel-interpolation: The channel interpolation, please refer to the supported values for a given Link Mode in the AD917x datasheet.
Optional properties:
- adi,jesd-subclass: The JESD204 subclass (0, 1).
- adi,clock-output-divider: Divide down DAC clock, supported values (ratios) are 0 (disabled), 1, 2, 3. The clock output frequency ranges from 727.8Mhz to 2GHz.
- adi,syncoutb-signal-type-lvds-enable: Enables LVDS mode for the SYNCOUTB signal, default is CMOS.
- adi,sysref-coupling-dc-enable: Enables SYSREF signal DC coupling, default is AC coupling.
- reset-gpio: a GPIO spec for the reset pin.
- txen0-gpio: a GPIO spec for the TXEN0 pin.
- txen1-gpio: a GPIO spec for the TXEN1 pin.
Example:
dac0_ad9172: ad9172@1 {
#address-cells = <1>;
#size-cells = <0>;
compatible = "adi,ad9172";
reg = <1>;
spi-max-frequency = <1000000>;
clocks = <&axi_ad9172_jesd>, <&hmc7044 2>, <&hmc7044 3>;
clock-names = "jesd_dac_clk", "dac_clk", "dac_sysref";
adi,dac-rate-khz = <3000000>;
adi,jesd-link-mode = <10>;
adi,jesd-subclass = <0>;
adi,dac-interpolation = <1>;
adi,channel-interpolation = <1>;
adi,clock-output-divider = <1>;
adi,syncoutb-signal-type-lvds-enable;
};
Enabling Linux driver support
Configure kernel with “make menuconfig” (alternatively use “make xconfig” or “make qconfig”)
The AD9172 driver depends on CONFIG_SPI
Adding Linux driver support
Configure kernel with “make menuconfig” (alternatively use “make xconfig” or “make qconfig”)
Linux Kernel Configuration Device Drivers ---> <*> Industrial I/O support ---> --- Industrial I/O support -*- Enable ring buffer support within IIO -*- Industrial I/O lock free software ring -*- Enable triggered sampling support *** Direct Digital Synthesis *** [--snip--] <*> Analog Devices CoreFPGA AXI DDS driver <*> Analog Devices AD917x DAC [--snip--]
Hardware configuration
In case the driver probes successfully and the device gets instantiated. Your systems kernel messages should include a lines, which may look like the one shown below.
ad9172 spi1.1: AD916x DAC Chip ID: 4 ad9172 spi1.1: AD916x DAC Product ID: 9172 ad9172 spi1.1: AD916x DAC Product Grade: 0 ad9172 spi1.1: AD916x DAC Product Revision: 2 ad9172 spi1.1: AD916x Revision: 1.1.1 ad9172 spi1.1: PLL Input rate 368640000 ad9172 spi1.1: PLL lock status 1, DLL lock status: 1 ad9172 spi1.1: Serdes PLL Locked (stat: 3) ad9172 spi1.1: code_grp_sync: f ad9172 spi1.1: frame_sync_stat: f ad9172 spi1.1: good_checksum_stat: f ad9172 spi1.1: init_lane_sync_stat: f ad9172 spi1.1: 4 lanes @ 7372800 kBps ad9172 spi1.1: Probed. cf_axi_dds 84a04000.axi-ad9172-hpc: Analog Devices CF_AXI_DDS_DDS MASTER (9.00.b) at 0x84A04000 mapped to 0xffffff800d0f0000, probed DDS AD9172
Driver testing
Each and every IIO device, typically a hardware chip, has a device folder under /sys/bus/iio/devices/iio:deviceX. Where X is the IIO index of the device. Under every of these directory folders reside a set of files, depending on the characteristics and features of the hardware device in question. These files are consistently generalized and documented in the IIO ABI documentation. In order to determine which IIO deviceX corresponds to which hardware device, the user can read the name file /sys/bus/iio/devices/iio:deviceX/name. In case the sequence in which the iio device drivers are loaded/registered is constant, the numbering is constant and may be known in advance.
Some device attributes control the DDS HDL Core, others features of the DAC and associated clock providers.
This specifies any shell prompt running on the target
analog:/sys/bus/iio/devices/iio:device2# cd /sys/bus/iio/devices/ root@analog:/sys/bus/iio/devices# ls iio:device0 iio:device1 iio:device2 iio:device3 root@analog:/sys/bus/iio/devices# root@analog:/sys/bus/iio/devices# cd iio\:device2 root@analog:/sys/bus/iio/devices/iio:device2# ls -l total 0 drwxr-xr-x 5 root root 0 Apr 12 12:01 . drwxr-xr-x 4 root root 0 Apr 12 12:01 .. drwxrwxrwx 2 root root 0 Apr 12 12:01 buffer -rw-rw-rw- 1 root root 4096 Apr 12 12:01 dev -rw-rw-rw- 1 root root 4096 Apr 12 12:01 name lrwxrwxrwx 1 root root 0 Apr 12 12:01 of_node -> ../../../../../firmware/devicetree/base/fpga-axi@0/axi-ad9172-hpc@84a04000 -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage0_TX1_I_F1_frequency -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage0_TX1_I_F1_phase -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage0_TX1_I_F1_raw -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage0_TX1_I_F1_scale -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage1_TX1_I_F2_frequency -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage1_TX1_I_F2_phase -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage1_TX1_I_F2_raw -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage1_TX1_I_F2_scale -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage2_TX1_Q_F1_frequency -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage2_TX1_Q_F1_phase -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage2_TX1_Q_F1_raw -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage2_TX1_Q_F1_scale -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage3_TX1_Q_F2_frequency -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage3_TX1_Q_F2_phase -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage3_TX1_Q_F2_raw -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage3_TX1_Q_F2_scale -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage4_TX2_I_F1_frequency -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage4_TX2_I_F1_phase -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage4_TX2_I_F1_raw -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage4_TX2_I_F1_scale -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage5_TX2_I_F2_frequency -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage5_TX2_I_F2_phase -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage5_TX2_I_F2_raw -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage5_TX2_I_F2_scale -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage6_TX2_Q_F1_frequency -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage6_TX2_Q_F1_phase -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage6_TX2_Q_F1_raw -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage6_TX2_Q_F1_scale -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage7_TX2_Q_F2_frequency -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage7_TX2_Q_F2_phase -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage7_TX2_Q_F2_raw -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage7_TX2_Q_F2_scale -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_altvoltage_sampling_frequency -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_voltage0_i_scale -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_voltage0_nco_enable -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_voltage0_nco_frequency -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_voltage0_nco_phase -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_voltage0_q_scale -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_voltage1_i_scale -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_voltage1_nco_enable -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_voltage1_nco_frequency -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_voltage1_nco_phase -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_voltage1_q_scale -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_voltage6_nco_enable -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_voltage6_nco_frequency -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_voltage6_nco_phase -rw-rw-rw- 1 root root 4096 Apr 12 12:01 out_voltage_sampling_frequency drwxrwxrwx 2 root root 0 Apr 12 12:01 power drwxrwxrwx 2 root root 0 Apr 12 12:01 scan_elements lrwxrwxrwx 1 root root 0 Apr 12 12:01 subsystem -> ../../../../../bus/iio -rw-rw-rw- 1 root root 4096 Apr 12 12:01 uevent root@analog:/sys/bus/iio/devices/iio:device2#
Documentation for following subfolders and channel attributes can be found here: AXI DAC HDL Linux Driver
- buffer
- name
- out_altvoltage0_TX1_I_F1_frequency
- out_altvoltage0_TX1_I_F1_phase
- out_altvoltage0_TX1_I_F1_raw
- out_altvoltage0_TX1_I_F1_scale
- out_altvoltage1_TX1_I_F2_frequency
- out_altvoltage1_TX1_I_F2_phase
- out_altvoltage1_TX1_I_F2_raw
- out_altvoltage1_TX1_I_F2_scale
- out_altvoltage2_TX1_Q_F1_frequency
- out_altvoltage2_TX1_Q_F1_phase
- out_altvoltage2_TX1_Q_F1_raw
- out_altvoltage2_TX1_Q_F1_scale
- out_altvoltage3_TX1_Q_F2_frequency
- out_altvoltage3_TX1_Q_F2_phase
- out_altvoltage3_TX1_Q_F2_raw
- out_altvoltage3_TX1_Q_F2_scale
- out_altvoltage4_TX2_I_F1_frequency
- out_altvoltage4_TX2_I_F1_phase
- out_altvoltage4_TX2_I_F1_raw
- out_altvoltage4_TX2_I_F1_scale
- out_altvoltage5_TX2_I_F2_frequency
- out_altvoltage5_TX2_I_F2_phase
- out_altvoltage5_TX2_I_F2_raw
- out_altvoltage5_TX2_I_F2_scale
- out_altvoltage6_TX2_Q_F1_frequency
- out_altvoltage6_TX2_Q_F1_phase
- out_altvoltage6_TX2_Q_F1_raw
- out_altvoltage6_TX2_Q_F1_scale
- out_altvoltage7_TX2_Q_F2_frequency
- out_altvoltage7_TX2_Q_F2_phase
- out_altvoltage7_TX2_Q_F2_raw
- out_altvoltage7_TX2_Q_F2_scale
- out_altvoltage_sampling_frequency
- scan_elements
Show device name
This specifies any shell prompt running on the target
root@analog:/sys/bus/iio/devices/iio:device2# cat name axi-ad9172-hpc
Digital channel controls
For each of the channel digital datapaths (when not using 1× interpolation for the channel), there are individually programmable gain stages and NCO blocks available. The NCO blocks have a 48-bit modulus NCO option to enable digital frequency shifts of signals with near infinite precision. The number of channels (X) depend on the JESD204 link mode. Please refer to the AD917x datasheet.
At the end of the three channelizer datapaths, there is a summation node that combines the three channel datapaths together at a maximum of 1.5 GSPS to then pass along to each of the main DAC datapaths for further digital feature options.
Set channel gain
What: out_voltageX_i_scale, out_voltageX_q_scale
Sets the scalar channel gain value. Range is from 0.0000 to 1.9999
This specifies any shell prompt running on the target
root@analog:/sys/bus/iio/devices/iio:device2# echo 0.85 > out_voltage0_q_scale root@analog:/sys/bus/iio/devices/iio:device2# cat out_voltage0_q_scale 0.849609375
Enable/disable channel NCO
What: out_voltageX_nco_enable
Enable/Disable NCOs. (Values 0, 1)
This specifies any shell prompt running on the target
root@analog:/sys/bus/iio/devices/iio:device2# echo 1 > out_voltage0_nco_enable root@analog:/sys/bus/iio/devices/iio:device2# cat out_voltage0_nco_enable 1
Set channel NCO frequency
What: out_voltageX_nco_frequency
Set channel NCO frequency (fCARRIER) in Hz
Range is: −(fDAC/Main Interpolation)/2 ≤ fCARRIER < +(fDAC/Main Interpolation)/2
This specifies any shell prompt running on the target
root@analog:/sys/bus/iio/devices/iio:device2# echo 400000000 > out_voltage0_nco_frequency root@analog:/sys/bus/iio/devices/iio:device2# cat out_voltage0_nco_frequency 400000000
Set channel NCO phase offset
What: out_voltageX_nco_phase
Sets main datapath and/or channel datapath NCO phase offset. Range is −180° ≤ Degrees Offset ≤ +180° (Values are in milli degrees.)
This specifies any shell prompt running on the target
root@analog:/sys/bus/iio/devices/iio:device2# echo 120000 > out_voltage0_nco_phase root@analog:/sys/bus/iio/devices/iio:device2# cat out_voltage0_nco_phase 119998
Main DAC datapaths controls
Each of the main DAC datapaths contain an optional power amplifier (PA) protection block, a main datapath interpolation block, a main NCO with an optional modulus feature, and a ramp-up/ramp-down gain block that is fed by the PA protection block. Additionally, there is an optional calibration tone feature, as well as four modulator switch modes that are part of the main NCO block.
Enable/disable main datapath DAC NCO
What: out_voltage6_nco_enable
Enable/Disable main datapath DAC NCO. (Values 0, 1)
This specifies any shell prompt running on the target
root@analog:/sys/bus/iio/devices/iio:device2# echo 1 > out_voltage6_nco_enable root@analog:/sys/bus/iio/devices/iio:device2# cat out_voltage6_nco_enable 1
Set main datapath DAC NCO frequency
What: out_voltage6_nco_frequency
Set main datapath DAC NCO frequency (fCARRIER) in Hz Range is: −fDAC/2 ≤ fCARRIER < +fDAC/2
This specifies any shell prompt running on the target
root@analog:/sys/bus/iio/devices/iio:device2# echo 2250000000 > out_voltage6_nco_frequency root@analog:/sys/bus/iio/devices/iio:device2# cat out_voltage6_nco_frequency 2250000000
Set main datapath DAC NCO phase offset
What: out_voltage6_nco_phase
Sets main datapath and/or channel datapath NCO phase offset. Range is −180° ≤ Degrees Offset ≤ +180° (Values are in milli degrees.)
This specifies any shell prompt running on the target
root@analog:/sys/bus/iio/devices/iio:device2# echo 120000 > out_voltage6_nco_phase root@analog:/sys/bus/iio/devices/iio:device2# cat out_voltage6_nco_phase 119998
More Information
- IIO mailing list: linux [dash] iio [at] vger [dot] kernel [dot] org
resources/tools-software/linux-drivers/iio-dds/ad9172.1558949478.txt.gz · Last modified: 27 May 2019 11:31 by Michael Hennerich