-
Notifications
You must be signed in to change notification settings - Fork 36
reference-designs/eval-ad7134-fmcz: Add eval-ad7134-fmcz documentation #400
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
Open
mandrica
wants to merge
2
commits into
main
Choose a base branch
from
ad7134_doc
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
486 changes: 486 additions & 0 deletions
486
docs/solutions/reference-designs/eval-ad7134-fmcz/ad7134_iio_support.rst
Large diffs are not rendered by default.
Oops, something went wrong.
3 changes: 3 additions & 0 deletions
3
docs/solutions/reference-designs/eval-ad7134-fmcz/images/ad7134_block_diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
docs/solutions/reference-designs/eval-ad7134-fmcz/images/ad7134_chip.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
...utions/reference-designs/eval-ad7134-fmcz/images/ad7134_data_capture_window.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
docs/solutions/reference-designs/eval-ad7134-fmcz/images/ad7134_debug_window.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
docs/solutions/reference-designs/eval-ad7134-fmcz/images/ad7134_dmm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
docs/solutions/reference-designs/eval-ad7134-fmcz/images/ad7134_eval.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
docs/solutions/reference-designs/eval-ad7134-fmcz/images/ad7134_fw_structure.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
...tions/reference-designs/eval-ad7134-fmcz/images/ad7134_hardware_setup_linux.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
...tions/reference-designs/eval-ad7134-fmcz/images/ad7134_hardware_setup_no_os.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
docs/solutions/reference-designs/eval-ad7134-fmcz/images/ad7134_hw_connection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
...olutions/reference-designs/eval-ad7134-fmcz/images/ad7134_iio_block_diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
docs/solutions/reference-designs/eval-ad7134-fmcz/images/ad7134_iio_devices.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
.../solutions/reference-designs/eval-ad7134-fmcz/images/ad7134_iio_osc_connect.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
docs/solutions/reference-designs/eval-ad7134-fmcz/images/ad7134_iio_osc_plot.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
docs/solutions/reference-designs/eval-ad7134-fmcz/images/ad7134_iio_windows.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
docs/solutions/reference-designs/eval-ad7134-fmcz/images/ad7134_platform_drv.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
docs/solutions/reference-designs/eval-ad7134-fmcz/images/ad7134_reg_map.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
docs/solutions/reference-designs/eval-ad7134-fmcz/images/ad7134_scopy_ch1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
docs/solutions/reference-designs/eval-ad7134-fmcz/images/ad7134_scopy_ch2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
...solutions/reference-designs/eval-ad7134-fmcz/images/ad7134_zed_jtag_jumpers.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
...olutions/reference-designs/eval-ad7134-fmcz/images/ad7134_zed_linux_jumpers.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
...olutions/reference-designs/eval-ad7134-fmcz/images/ad717x_assigned_com_port.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
...ns/reference-designs/eval-ad7134-fmcz/images/ad717x_installing_dependencies.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
.../reference-designs/eval-ad7134-fmcz/images/ad717x_number_of_samples_request.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
...utions/reference-designs/eval-ad7134-fmcz/images/ad717x_phy_and_virtual_com.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
.../solutions/reference-designs/eval-ad7134-fmcz/images/ad717x_py_env_variable.png
Oops, something went wrong.
3 changes: 3 additions & 0 deletions
3
...solutions/reference-designs/eval-ad7134-fmcz/images/ad717x_py_version_check.png
Oops, something went wrong.
3 changes: 3 additions & 0 deletions
3
...ons/reference-designs/eval-ad7134-fmcz/images/ad717x_pyadi-iio_installation.png
Oops, something went wrong.
3 changes: 3 additions & 0 deletions
3
docs/solutions/reference-designs/eval-ad7134-fmcz/images/ad717x_python_output.png
Oops, something went wrong.
3 changes: 3 additions & 0 deletions
3
docs/solutions/reference-designs/eval-ad7134-fmcz/images/ad717x_update_uri.png
Oops, something went wrong.
3 changes: 3 additions & 0 deletions
3
docs/solutions/reference-designs/eval-ad7134-fmcz/images/ad717x_vir_com_port.png
Oops, something went wrong.
142 changes: 142 additions & 0 deletions
142
docs/solutions/reference-designs/eval-ad7134-fmcz/index.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,142 @@ | ||
| .. _eval-ad7134-fmcz: | ||
|
|
||
| EVAL-AD7134-FMCZ | ||
| ================= | ||
|
|
||
| 24-Bit, 4-Channel Simultaneous Sampling 1.5 MSPS Precision Alias Free ADC | ||
|
|
||
| .. image:: images/ad7134_chip.png | ||
| :align: left | ||
| :width: 100 | ||
|
|
||
| Overview | ||
| -------- | ||
|
|
||
| The :adi:`AD7134` is a 24-bit, 4-channel simultaneous sampling 1.5MSPS, | ||
| precision, alias free ADC. It contains a continuous time Σ-Δ modulation | ||
| technology that does not use sample-and-hold circuitry to alleviate the side | ||
| effects introduced by it, like charge kickback and signal aliasing. This | ||
| inherent alias rejection is up to 100dB. | ||
|
|
||
| The device has an asynchronous sample rate converter used to synchronize two | ||
| or more devices using only a signal line. To do this one of the devices will | ||
| generate the synchronization signal while the others will receive it. This | ||
| also allows for freely programmable data rates from 10SPS up to 1.496MSPS. | ||
|
|
||
| It has excellent AC and DC performance with 107dB dynamic for the FIR filter | ||
| at 374kSPS and 138dB dynamic range for the sinc3 filter at 10SPS. The offset | ||
| drift is 1.5uV/°C, gain drift of 2ppm/°C and INL of ±2.5ppm. | ||
|
|
||
| It can be powered from a 4.5V to 5.5V power supply and a 1.65V to 1.95V | ||
| digital power supply for 1.8V I/O level. It can have external voltage | ||
| reference of 2.5V, 4.096V and 5V and a crystal or CMOS external clock of | ||
| 48MHz. The device can be configured and controlled by GPIOs or SPI. It has | ||
| temperature operating range between 0°C and 85°C. | ||
|
|
||
| Features: | ||
|
|
||
| - 24-bit, 4-channel simultaneous sampling ADC | ||
| - Throughput of up to 1.496 MSPS | ||
| - Alias-free continuous time Σ-Δ modulation (up to 100dB rejection) | ||
| - Freely programmable data rates from 10SPS to 1.496MSPS | ||
| - Asynchronous sample rate converter for multi-device synchronization | ||
| - SPI or GPIO configuration and control | ||
|
|
||
| Applications: | ||
|
|
||
| - Electrical test and measurement | ||
| - Audio test | ||
| - 3-phase power quality analysis | ||
| - Control and hardware in loop verification | ||
| - Sonar | ||
| - Condition and monitoring for predictive maintenance | ||
| - Acoustic and material science research and development | ||
|
|
||
| .. figure:: images/ad7134_eval.png | ||
| :align: center | ||
| :width: 400 | ||
|
|
||
| EVAL-AD7134FMCZ evaluation board | ||
|
|
||
| Recommendations | ||
| --------------- | ||
|
|
||
| People who follow the flow that is outlined, have a much better experience | ||
| with things. However, like many things, documentation is never as complete | ||
| as it should be. If you have any questions, feel free to ask on our | ||
| :ref:`EngineerZone forums <help-and-support>`, but before that, please make | ||
| sure you read our documentation thoroughly. | ||
|
|
||
| To better understand the :adi:`AD7134`, we recommend to use the | ||
| :adi:`EVAL-AD7134FMCZ` evaluation board. | ||
|
|
||
| Table of contents | ||
| ----------------- | ||
|
|
||
| #. Using the evaluation board/full stack reference design that we offer: | ||
|
|
||
| #. :ref:`Prerequisites <eval-ad7134-fmcz prerequisites>` - what you | ||
| need to get started | ||
| #. :ref:`Quick start guides <eval-ad7134-fmcz quickstart>`: | ||
|
|
||
| #. Using the :ref:`Zedboard/ Zynq-7000 SoC | ||
| <eval-ad7134-fmcz quickstart zed>` | ||
|
|
||
| #. Configure an SD Card with | ||
| :external+kuiper:doc:`Kuiper <index>` | ||
|
|
||
| #. Linux Applications | ||
|
|
||
| #. :ref:`iio-oscilloscope` | ||
|
|
||
| #. :ref:`AD7134 IIO Application | ||
| <eval-ad7134-fmcz ad7134-iio-support>` (no-OS / MBED / STM32) | ||
|
|
||
| #. Design with the AD7134 | ||
|
|
||
| #. HDL reference design | ||
|
|
||
| #. :external+hdl:ref:`HDL reference design <ad7134_fmc>` which | ||
| you must use in your FPGA. | ||
| #. :git-hdl:`AD7134 HDL Reference Design | ||
| <projects/ad7134_fmc>` which you must use in your FPGA. | ||
|
|
||
| #. More information | ||
|
|
||
| #. :external+hdl:ref:`SPI Engine Framework <spi_engine>` | ||
|
|
||
| #. :ref:`Help and Support <help-and-support>` | ||
|
|
||
| Functional Block Diagram | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| .. figure:: images/ad7134_block_diagram.png | ||
| :width: 1000 | ||
|
|
||
| AD7134 functional block diagram | ||
|
|
||
| .. toctree:: | ||
| :hidden: | ||
|
|
||
| user-guide | ||
| quickstart/index | ||
| prerequisites | ||
| ad7134_iio_support | ||
|
|
||
| Additional Information and Useful Links | ||
| ---------------------------------------- | ||
|
|
||
| - :adi:`AD7134 Product Page <AD7134>` | ||
| - :adi:`EVAL-AD7134FMCZ Evaluation Board <EVAL-AD7134FMCZ>` | ||
| - :adi:`AD7134 Data Sheet | ||
| <media/en/technical-documentation/data-sheets/ad7134.pdf>` | ||
|
|
||
| Warning | ||
| -------- | ||
|
|
||
| .. esd-warning:: | ||
|
|
||
| Help and support | ||
| ---------------- | ||
|
|
||
| Please go to :ref:`Help and Support <help-and-support>` page. | ||
59 changes: 59 additions & 0 deletions
59
docs/solutions/reference-designs/eval-ad7134-fmcz/prerequisites.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| .. _eval-ad7134-fmcz prerequisites: | ||
|
|
||
| Prerequisites | ||
| ============= | ||
|
|
||
| What you need, depends on what you are trying to do. As a minimum, you need to | ||
| start out with: | ||
|
|
||
| Hardware prerequisites | ||
| ---------------------- | ||
|
|
||
| #. The AD7134 evaluation board: :adi:`EVAL-AD7134FMCZ` | ||
| #. An FPGA carrier platform. Our recommended ones can be found | ||
| :ref:`here <eval-ad7134-fmcz carriers>`. | ||
|
|
||
| - There are a few more boards, which do work, but are currently not | ||
| supported by us. The experience with the fabric-only solutions is very | ||
| close to the ARM/FPGA SoC based solutions, but the GUI runs on a host PC | ||
| (Windows or Linux). | ||
|
|
||
| #. Some way to interact with the FPGA platform: | ||
|
|
||
| #. for the ARM/FPGA SoC platforms, this normally includes: | ||
|
|
||
| - Micro‑USB cable for UART console | ||
| - LAN cable (Ethernet) for SSH or IIO applications | ||
| - HDMI or DisplayPort monitor (Optional) | ||
| - USB Keyboard (Optional) | ||
| - USB Mouse (Optional) | ||
|
|
||
| #. for the FPGA only solutions, this includes: | ||
|
|
||
| - LAN cable (Ethernet) | ||
| - Host PC (Windows or Linux) | ||
| - Micro‑USB cable for UART | ||
| - Micro‑USB cable for JTAG (PROG) | ||
|
|
||
| #. Internet connection (without proxies makes things much easier) to update | ||
| the scripts/binaries on the SD card that came with the ADI FMC Card | ||
| (firewalls are OK, proxies make things a pain). | ||
| #. Test equipment for generating analog input signals. | ||
| #. An SD card with at least 16GB of memory (in case you're using Linux). You | ||
| should have received one when purchasing the evaluation board. | ||
|
|
||
| Software prerequisites | ||
| ---------------------- | ||
|
|
||
| Normally, for basic functionalities regarding visualizing the data received | ||
| from the FPGA, we use the following: | ||
|
|
||
| #. :external+scopy:doc:`Scopy <index>` v2.0 or later (must contain the IIO | ||
| plugin) | ||
| #. :git-iio-oscilloscope:`IIO Oscilloscope <releases+>` | ||
| #. UART terminal application (PuTTY/TeraTerm/Minicom/MobaXterm), 115200, 8N1 | ||
|
|
||
| .. note:: | ||
|
|
||
| :adi:`ADI <>` does not offer FPGA carrier platforms for sale or loan; | ||
| getting one yourself is the normal part of development or evaluation. |
69 changes: 69 additions & 0 deletions
69
docs/solutions/reference-designs/eval-ad7134-fmcz/quickstart/index.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| .. _eval-ad7134-fmcz quickstart: | ||
|
|
||
| Quickstart | ||
| ========== | ||
|
|
||
| The Quick start guides provide simple step by step instructions on how to | ||
| do an initial system setup for the :adi:`EVAL-AD7134FMCZ` board on various | ||
| FPGA development boards. In these guides, we will discuss how to program | ||
| the bitstream, run a no-OS program or boot a Linux distribution. | ||
|
|
||
| .. toctree:: | ||
|
|
||
| Zedboard <zed> | ||
|
|
||
| .. _eval-ad7134-fmcz carriers: | ||
|
|
||
| Supported carriers | ||
| ------------------ | ||
|
|
||
| The :adi:`EVAL-AD7134FMCZ`, is, by definition a "FPGA | ||
| mezzanine card" (FMC); that means it needs a carrier to plug into. | ||
|
|
||
| The carriers we support are: | ||
|
|
||
| .. list-table:: | ||
| :header-rows: 1 | ||
|
|
||
| - - FPGA board | ||
| - EVAL-AD7134-FMCZ | ||
| - - `ZedBoard | ||
| <https://digilent.com/reference/programmable-logic/zedboard/start>`__ | ||
| - FMC LPC | ||
|
|
||
| Supported Environments | ||
| ---------------------- | ||
|
|
||
| The supported OS are: | ||
|
|
||
| .. list-table:: | ||
| :header-rows: 1 | ||
|
|
||
| - - FPGA board | ||
| - HDL | ||
| - Linux software | ||
| - No-OS software | ||
| - - `ZedBoard | ||
| <https://digilent.com/reference/programmable-logic/zedboard/start>`__ | ||
| - Yes | ||
| - Yes | ||
| - Yes | ||
|
|
||
| Hardware Setup | ||
| -------------- | ||
|
|
||
| The :adi:`EVAL-AD7134FMCZ` board connects to the FMC LPC | ||
| connector of the carrier board. The carrier setup requires power, | ||
| UART (115200), ethernet (Linux), HDMI (if available) and/or JTAG (no-OS) | ||
| connections. | ||
|
|
||
| A few typical setups are shown below. | ||
|
|
||
| ZedBoard + EVAL-AD7134FMCZ | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| .. figure:: ../images/ad7134_hardware_setup_linux.jpg | ||
| :align: center | ||
| :width: 500 | ||
|
|
||
| ZedBoard + EVAL-AD7134FMCZ hardware setup |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Put the short description here, and the chip photo. Example https://github.com/analogdevicesinc/documentation/blob/main/docs/solutions/reference-designs/eval-ad9081/index.rst?plain=1#L6
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.