-
Notifications
You must be signed in to change notification settings - Fork 36
reference-designs/admx100x_evb: Added ADMX100X documentation #438
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
BCapota
wants to merge
1
commit into
main
Choose a base branch
from
admx100x
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
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
3 changes: 3 additions & 0 deletions
3
docs/solutions/reference-designs/admx100x_evb/images/EVAL-ADMX100X-FMCZ.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/admx100x_evb/images/admx1001_eval-admx1001fmcz_zed_setup.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/admx100x_evb/images/admx1002.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/admx100x_evb/images/admx100x_gui_overview.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/admx100x_evb/images/admx100x_gui_status_panel.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/admx100x_evb/images/admx100x_module.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
...ons/reference-designs/admx100x_evb/images/admx100x_simplified_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
...lutions/reference-designs/admx100x_evb/images/admx100x_zed_frequency_domain.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/admx100x_evb/images/admx100x_zed_time_domain.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/admx100x_evb/images/after_dpd.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/admx100x_evb/images/before_dpd.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/admx100x_evb/images/complete_setup_using_sdp-h1.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/admx100x_evb/images/dpd_before_and_after.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/admx100x_evb/images/eval-admx1001.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/admx100x_evb/images/eval-admx1002.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
...s/reference-designs/admx100x_evb/images/eval-admx100x-fmcz_evaluation_board.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/admx100x_evb/images/eval-admx100x-fmczkit-angle-web.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/admx100x_evb/images/extractingcomponents.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/admx100x_evb/images/generate_awg.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/admx100x_evb/images/gui_acquisition.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/admx100x_evb/images/gui_analog_input.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/admx100x_evb/images/gui_analog_output.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/admx100x_evb/images/gui_awg.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/admx100x_evb/images/gui_captured_waveform.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/admx100x_evb/images/gui_dc.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/admx100x_evb/images/gui_dualtone.png
Oops, something went wrong.
3 changes: 3 additions & 0 deletions
3
docs/solutions/reference-designs/admx100x_evb/images/gui_loadingprofile.png
Oops, something went wrong.
3 changes: 3 additions & 0 deletions
3
docs/solutions/reference-designs/admx100x_evb/images/gui_lowdistortion.png
Oops, something went wrong.
3 changes: 3 additions & 0 deletions
3
docs/solutions/reference-designs/admx100x_evb/images/gui_singletone.png
Oops, something went wrong.
3 changes: 3 additions & 0 deletions
3
docs/solutions/reference-designs/admx100x_evb/images/gui_spectrum_settings.png
Oops, something went wrong.
3 changes: 3 additions & 0 deletions
3
docs/solutions/reference-designs/admx100x_evb/images/gui_storingprofile.png
Oops, something went wrong.
3 changes: 3 additions & 0 deletions
3
...eference-designs/admx100x_evb/images/gui_waveform_and_spectrum_measurements.png
Oops, something went wrong.
3 changes: 3 additions & 0 deletions
3
...solutions/reference-designs/admx100x_evb/images/installation_wizard_welcome.png
Oops, something went wrong.
3 changes: 3 additions & 0 deletions
3
...ference-designs/admx100x_evb/images/load_and_enable_profile_with_sequencing.png
Oops, something went wrong.
3 changes: 3 additions & 0 deletions
3
docs/solutions/reference-designs/admx100x_evb/images/sdp-h1_setup.png
Oops, something went wrong.
3 changes: 3 additions & 0 deletions
3
docs/solutions/reference-designs/admx100x_evb/images/sdp-i-pmod_jumper-spi.jpg
Oops, something went wrong.
3 changes: 3 additions & 0 deletions
3
docs/solutions/reference-designs/admx100x_evb/images/sdp-s_setup.png
Oops, something went wrong.
3 changes: 3 additions & 0 deletions
3
docs/solutions/reference-designs/admx100x_evb/images/spectrumsettings.png
Oops, something went wrong.
145 changes: 145 additions & 0 deletions
145
docs/solutions/reference-designs/admx100x_evb/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,145 @@ | ||||||||||||||
| .. _admx100x: | ||||||||||||||
|
|
||||||||||||||
| ADMX1001 & ADMX1002 | ||||||||||||||
| =================== | ||||||||||||||
|
|
||||||||||||||
| Ultra-low distortion, low noise signal generator and acquisition evaluation | ||||||||||||||
| modules. | ||||||||||||||
|
|
||||||||||||||
| .. grid:: | ||||||||||||||
| :widths: 50% 50% | ||||||||||||||
|
|
||||||||||||||
| .. figure:: images/eval-admx1001.png | ||||||||||||||
| :width: 500 | ||||||||||||||
|
|
||||||||||||||
| ADMX1001 | ||||||||||||||
|
|
||||||||||||||
| .. figure:: images/eval-admx1002.png | ||||||||||||||
| :width: 500 | ||||||||||||||
|
|
||||||||||||||
| ADMX1002 | ||||||||||||||
|
|
||||||||||||||
| Overview | ||||||||||||||
| -------- | ||||||||||||||
|
|
||||||||||||||
| The :adi:`EVAL-ADMX100X-FMCZ` is an evaluation board for the :adi:`ADMX1001` and | ||||||||||||||
| :adi:`ADMX1002` ultra-low distortion, low-noise signal generator modules from | ||||||||||||||
| Analog Devices. The **EVAL-ADMX100X-FMCZ** evaluation board provides the | ||||||||||||||
| necessary interface circuitry to connect the ADMX100X module to a host PC via | ||||||||||||||
| the SDP-H1 controller board, or alternatively via the SDP-S or SDP-B controller | ||||||||||||||
| boards with the SDP-I-PMOD interposer. | ||||||||||||||
|
|
||||||||||||||
| The **ADMX1001** and **ADMX1002** modules are high-performance signal generators | ||||||||||||||
| designed for applications requiring ultra-low harmonic distortion. The DPD | ||||||||||||||
| algorithm exploits a patented differential temporal and amplitude sensing method | ||||||||||||||
| that requires no external reference inputs, enabling exceptional signal purity | ||||||||||||||
| through self-sensing correction. The ADMX1001 and ADMX1002 are capable of | ||||||||||||||
| generating signals up to 40 kHz without Digital Pre-Distortion (DPD), or up to | ||||||||||||||
| 20 kHz with DPD enabled, achieving −130 dBc typical Total Harmonic Distortion | ||||||||||||||
| (THD) at 1 kHz. | ||||||||||||||
|
|
||||||||||||||
| The **ADMX1001** uniquely includes a differential input acquisition channel to | ||||||||||||||
| measure a signal of choice, while the **ADMX1002** focuses solely on signal | ||||||||||||||
| generation. | ||||||||||||||
|
|
||||||||||||||
| Features: | ||||||||||||||
|
|
||||||||||||||
| - SPI and ATE communication interface | ||||||||||||||
| - On-board power supply regulation | ||||||||||||||
| - External common-mode voltage option | ||||||||||||||
| - Sync In and Sync Out for coherent sampling | ||||||||||||||
| - External output clamp voltage option | ||||||||||||||
| - Differential to single-ended conversion | ||||||||||||||
|
|
||||||||||||||
| Applications: | ||||||||||||||
|
|
||||||||||||||
| - Audio test and measurement | ||||||||||||||
| - Automated test equipment (ATE) | ||||||||||||||
| - Coherent sampling and ADC evaluation | ||||||||||||||
| - Ultra-low distortion signal generation | ||||||||||||||
| - Laboratory signal source | ||||||||||||||
|
|
||||||||||||||
| .. figure:: images/EVAL-ADMX100X-FMCZ.png | ||||||||||||||
| :align: center | ||||||||||||||
| :width: 500 | ||||||||||||||
|
|
||||||||||||||
| EVAL-ADMX100X-FMCZ | ||||||||||||||
|
|
||||||||||||||
| .. toctree:: | ||||||||||||||
| :hidden: | ||||||||||||||
|
|
||||||||||||||
| prerequisites | ||||||||||||||
| user-guide | ||||||||||||||
| quickstart/index | ||||||||||||||
|
|
||||||||||||||
| 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:`ADMX1001` / :adi:`ADMX1002`, we recommend to use | ||||||||||||||
| the :adi:`EVAL-ADMX100X-FMCZ` evaluation board. | ||||||||||||||
|
|
||||||||||||||
| Table of contents | ||||||||||||||
| ----------------- | ||||||||||||||
|
|
||||||||||||||
| #. Using the evaluation board: | ||||||||||||||
|
|
||||||||||||||
| #. :ref:`Prerequisites <admx100x prerequisites>` — what you need to get | ||||||||||||||
| started | ||||||||||||||
| #. :ref:`Quick start guides <admx100x-evb quickstart>`: | ||||||||||||||
|
|
||||||||||||||
| #. :ref:`SDP-H1 <admx100x-evb quickstart sdp-h1>` | ||||||||||||||
| #. :ref:`ZedBoard <admx100x-evb quickstart zed>` | ||||||||||||||
|
|
||||||||||||||
| #. :ref:`User Guide <admx100x-evb user-guide>` | ||||||||||||||
|
|
||||||||||||||
| #. More information | ||||||||||||||
|
|
||||||||||||||
| #. :external+hdl:ref:`SPI Engine Framework <spi_engine>` | ||||||||||||||
|
|
||||||||||||||
| #. Design with the :adi:`ADMX1001` / :adi:`ADMX1002` | ||||||||||||||
|
|
||||||||||||||
| - :adi:`ADMX1001 product page <ADMX1001>` | ||||||||||||||
| - :adi:`ADMX1002 product page <ADMX1002>` | ||||||||||||||
|
|
||||||||||||||
| #. :ref:`Help and Support <help-and-support>` | ||||||||||||||
|
|
||||||||||||||
| Block diagram | ||||||||||||||
| ------------- | ||||||||||||||
|
|
||||||||||||||
| .. figure:: images/admx100x_simplified_block_diagram.png | ||||||||||||||
| :align: center | ||||||||||||||
| :width: 800 | ||||||||||||||
|
|
||||||||||||||
| ADMX100X Simplified Block Diagram | ||||||||||||||
|
|
||||||||||||||
| ADI article | ||||||||||||||
| ----------- | ||||||||||||||
|
|
||||||||||||||
| - :adi:`High Performance Source for ADC and Audio Test with Novel Digital | ||||||||||||||
| Predistortion | ||||||||||||||
| <resources/technical-articles/high-performance-source-for-adc.html>` | ||||||||||||||
|
Comment on lines
+124
to
+126
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| Videos | ||||||||||||||
| ------ | ||||||||||||||
|
|
||||||||||||||
| - :adi:`Precision Narrow Bandwidth Signal Chain Solutions | ||||||||||||||
| <resources/media-center/videos/6301584622001.html>` | ||||||||||||||
| - :adi:`Ultra-Low Distortion Waveform Generator and Acquisition Module | ||||||||||||||
| <resources/media-center/videos/6355673963112.html>` | ||||||||||||||
|
Comment on lines
+131
to
+134
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| Warning | ||||||||||||||
| ------- | ||||||||||||||
|
|
||||||||||||||
| .. esd-warning:: | ||||||||||||||
|
|
||||||||||||||
| Help and support | ||||||||||||||
| ---------------- | ||||||||||||||
|
|
||||||||||||||
| For questions and more information, please visit the :ez:`/` technical support | ||||||||||||||
| community. | ||||||||||||||
43 changes: 43 additions & 0 deletions
43
docs/solutions/reference-designs/admx100x_evb/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,43 @@ | ||
| .. _admx100x 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 :adi:`ADMX1001` or :adi:`ADMX1002` signal generator module | ||
| #. The :adi:`EVAL-ADMX100X-FMCZ` evaluation board (includes 12 V wall adapter) | ||
| #. A controller board. Our recommended one can be found :ref:`here <admx100x-evb | ||
| quickstart carriers>`. | ||
|
|
||
| - AMD Xilinx `ZedBoard <https://digilent.com/reference/programmable-logic/zedboard/start>`__ | ||
| (supports both :adi:`ADMX1001` and :adi:`ADMX1002`); also requires an SD | ||
| card (at least 16 GB), a Micro-USB cable (UART), and a LAN cable (Ethernet) | ||
| - :adi:`SDP-H1 <en/resources/evaluation-hardware-and-software/evaluation-boards-kits/sdp-h1.html>` | ||
| (recommended, required for ADMX1001 acquisition channel) | ||
| - :adi:`SDP-S <en/resources/evaluation-hardware-and-software/evaluation-boards-kits/eval-sdp-cs1z.html>` | ||
| or :adi:`SDP-B <en/resources/evaluation-hardware-and-software/evaluation-boards-kits/eval-sdp-cb1z.html>` | ||
| with :adi:`SDP-I-PMOD <en/resources/evaluation-hardware-and-software/evaluation-boards-kits/sdp-i-pmod.html>` | ||
| interposer (ADMX1002 only); also requires a 6-pin PMOD cable and a 6 V | ||
| power adapter | ||
|
|
||
| #. USB cable (for SDP controller to PC connection) | ||
| #. Some way to interact with the evaluation board: | ||
|
|
||
| - Host PC | ||
| - SMA cables for signal routing to oscilloscope or spectrum analyzer | ||
| (optional) | ||
| - External common-mode voltage source, if not using on-board DAC via P4 | ||
| (optional) | ||
|
|
||
| Software prerequisites | ||
| ---------------------- | ||
|
|
||
| #. SDP USB drivers — must be installed before the GUI | ||
| #. :adi:`ADMX100X GUI <media/en/evaluation-boards-kits/evaluation-software/admx100x-evaluation-software.zip>` | ||
| software that will run on Windows 10 or later | ||
| #. For ZedBoard: :external+kuiper:doc:`ADI Kuiper Linux <index>` SD card image | ||
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.
Missing HDL section
Example:
#. :external+hdl:ref:
HDL reference design <admx100x_evb>which you mustuse in your FPGA.
And using with no-os/ linux sections