Skip to content

Commit 251f42c

Browse files
jvelasc2jvelasc2
committed
projects: AD713x_FMCZ: Added readme doc
Signed-off-by: Joyce Velasco <Joyce.Velasco@analog.com>
1 parent 1cc7551 commit 251f42c

File tree

2 files changed

+205
-0
lines changed

2 files changed

+205
-0
lines changed

‎doc/sphinx/source/projects/adc/ad713x_fmcz.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../../projects/ad713x_fmcz/README.rst

‎projects/ad713x_fmcz/README.rst‎

Lines changed: 204 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,204 @@
1+
AD713x_FMCZ no-OS Example Project
2+
=================================
3+
4+
.. contents::
5+
:depth: 3
6+
7+
Supported Evaluation Boards
8+
---------------------------
9+
10+
- :adi:`EVAL-AD7134FMCZ`
11+
12+
Overview
13+
--------
14+
15+
The EVAL-AD7134FMCZ evaluation board is tailored for the AD7134, a
16+
24-bit, 4-channel, simultaneous sampling ADC capable of 1.5 MSPS. It
17+
integrates two AD7134 ADCs for multidevice sampling demonstrations,
18+
connecting to a PC via the SDP-H1 board or operating standalone.
19+
Required input power ranges from 8V to 14V, regulated internally to 5V,
20+
1.8V, and 1.2V by onboard regulators. Distinct 4.096V references
21+
are provided by the ADR444 for each ADC. Clock inputs can be sourced
22+
from a crystal, MEMS oscillator, or CMOS input, enhancing its
23+
application versatility.
24+
25+
Applications
26+
------------
27+
28+
- Electrical test and measurement
29+
- Audio test
30+
- 3-phase power quality analysis
31+
- Control and hardware in loop verification
32+
- Sonars
33+
- Condition monitoring for predictive maintenance
34+
- Acoustic and material science research and development
35+
36+
Hardware Specifications
37+
------------------------
38+
39+
Power Supply Requirements
40+
~~~~~~~~~~~~~~~~~~~~~~~~~
41+
42+
The EVAL-AD7134FMCZ evaluation board requires an input power supply
43+
ranging from 8V to 14V. The onboard regulators internally convert this
44+
to the necessary operating voltages of 5V, 1.8V, and 1.2V needed for
45+
the system’s components. These power levels are essential for the proper
46+
functioning of the AD7134 ADCs on the board, which feature distinct
47+
4.096V references provided by the ADR444 to ensure accurate data
48+
conversion.
49+
50+
On-board Connectors
51+
~~~~~~~~~~~~~~~~~~~
52+
53+
+-----------------------+-----------------------+-----------------------+
54+
| Connector | Function | Connector Type |
55+
+-----------------------+-----------------------+-----------------------+
56+
| J1 | SMB connector for | Straight printed |
57+
| | XTAL2, external clock | circuit board (PCB) |
58+
| | input | mount |
59+
+-----------------------+-----------------------+-----------------------+
60+
| J2, J17 | Analog input SMB | SMB jacks |
61+
| | terminals for Channel | |
62+
| | 0 to Channel 7 | |
63+
+-----------------------+-----------------------+-----------------------+
64+
| P1, P7 | 8-pin connectors for | Fixed terminal |
65+
| | the eight | blocks, 2-pin, 3.81 |
66+
| | differential analog | mm, 90° |
67+
| | inputs | |
68+
+-----------------------+-----------------------+-----------------------+
69+
| P3 | Benchtop power supply | Fixed terminal |
70+
| | voltage input | blocks, 2-pin 2.54 |
71+
| | | mm, 90° |
72+
+-----------------------+-----------------------+-----------------------+
73+
| P5, P9 | Optional external | Vertical sockets |
74+
| | connectors for | |
75+
| | driver, Channel 0 and | |
76+
| | 4 | |
77+
+-----------------------+-----------------------+-----------------------+
78+
| P6, P10 | Optional external | Vertical sockets |
79+
| | connectors for | |
80+
| | driver, Channel 0 and | |
81+
| | 1 | |
82+
+-----------------------+-----------------------+-----------------------+
83+
| P8 | FMC Connector | 160-pin, 10 mm, male, |
84+
| | | VITA 57 connector |
85+
+-----------------------+-----------------------+-----------------------+
86+
87+
No-OS Build Setup
88+
-----------------
89+
90+
Please see: `https://wiki.analog.com/resources/no-os/build`
91+
92+
No-OS Supported Examples
93+
------------------------
94+
95+
The supported no-OS examples in the ad713x_fmcz project cover
96+
configurations for interfacing with IIO and UART on the Xilinx platform.
97+
Utilizing the AD713x driver, the examples demonstrate initializing and
98+
configuring ADC devices for SPI communication, managing device
99+
attributes, and handling data transfers through the IIO framework. The
100+
examples also include configurations for GPIO and SPI chip select
101+
management and setting storage for a clock reference frequency necessary
102+
for SPI communication. This project provides insight into dual AD7134
103+
device initialization, detailing the setup of channels and efficient
104+
data transfer processes.
105+
106+
The initialization data used in the examples is taken out from the
107+
`Project Source Data Path <https://github.com/analogdevicesinc/no-OS/tree/main/projects/ad713x_fmcz/src>`__.
108+
109+
UART example
110+
~~~~~~~~~~~~
111+
112+
The UART example code in the ad713x_fmcz project illustrates UART
113+
communication by configuring parameters such as device IDs, SPI engine
114+
settings, GPIO configurations, and initializing ADC devices. UART is set
115+
at a baud rate of 115200 using ``xil_uart_ops``, followed by SPI and PWM
116+
configurations. The AD7134 ADC devices are initialized for data
117+
communication over UART. Data is transmitted and stored in memory
118+
buffers, with synchronization ensuring integrity.
119+
120+
In order to build the basic example, make sure you have the following
121+
configuration in the
122+
`Makefile <https://github.com/analogdevicesinc/no-OS/blob/main/projects/ad713x_fmcz/Makefile>`__.
123+
124+
.. code-block:: bash
125+
126+
# Select the example you want to enable by choosing y for enabling and n for disabling
127+
UART = y
128+
IIOD = n
129+
130+
IIO example
131+
~~~~~~~~~~~
132+
133+
The IIO demo is a standard example, provided in most `no-OS
134+
projects <https://github.com/analogdevicesinc/no-OS/tree/main/projects>`__,
135+
that launches an IIOD server on the board so that the user may connect
136+
to it via an IIO client. Using the IIO Oscilloscope application, users
137+
can access device settings like offset, sampling frequency, and data
138+
scale, facilitating seamless data management and conversion of raw ADC
139+
readings into voltage signals.
140+
141+
If you are not familiar with ADI IIO Application, please take a look at:
142+
`IIO No-OS <https://wiki.analog.com/resources/tools-software/no-os-software/iio>`__
143+
144+
If you are not familiar with ADI IIO Oscilloscope Client, please take a
145+
look at: `IIO Oscilloscope <https://wiki.analog.com/resources/tools-software/linux-software/iio_oscilloscope>`__
146+
147+
To build the IIOD demo, add the following flag when invoking make. This
148+
will build the IIOD server and the IIO section of the driver:
149+
150+
.. code-block:: bash
151+
152+
# Select the example you want to enable by choosing y for enabling and n for disabling
153+
UART = n
154+
IIOD = y
155+
156+
No-OS Supported Platforms
157+
-------------------------
158+
159+
Xilinx
160+
~~~~~~~
161+
162+
Hardware Used
163+
^^^^^^^^^^^^^
164+
165+
- EVAL-AD7134FMCZ
166+
- ZedBoard
167+
168+
Connections
169+
^^^^^^^^^^^^
170+
171+
- Ensure both the ZedBoard and EVAL-AD7134FMCZ boards are powered off.
172+
173+
- Align the EVAL-AD7134FMCZ board over the ZedBoard so that the P8
174+
connector matches the ZedBoard’s FMC LPC socket.
175+
176+
- Firmly press the EVAL-AD7134FMCZ board onto the FMC LPC socket on the
177+
ZedBoard, ensuring a secure and straight connection.
178+
179+
- Supply the ZedBoard with 12VDC using its barrel jack (J20). Power
180+
for the EVAL-AD7134FMCZ is supplied via the FMC connector from the
181+
ZedBoard.
182+
183+
- Connect a MicroUSB cable from the ZedBoard’s USB-UART port (J14) to
184+
your PC.
185+
186+
- Ensure the ZedBoard’s boot jumpers (JP7 to JP11) and MIO0 (JP6) are set
187+
for your desired boot mode (typically SD Card for Linux demos).
188+
189+
- Power on the ZedBoard using the power switch (SW8). The
190+
EVAL-AD7134FMCZ will power on via the FMC connector. Confirm that
191+
status LEDs illuminate as expected on both boards.
192+
193+
Build Command
194+
^^^^^^^^^^^^^^
195+
196+
.. code-block:: bash
197+
198+
cp <SOME_PATH>/system_top.xsa .
199+
# to delete current build
200+
make reset
201+
# to build the project
202+
make
203+
# to flash the code
204+
make run

0 commit comments

Comments
 (0)