ad9084: Review & doc updates

docs/software/ad9084-profile-generator/index.rst

@@ -3,7 +3,7 @@
 AD9084 (Apollo) Profile Generator
 =================================
 
 The Apollo plugin comes bundled with the ACE software and can be downloaded
 from :adi:`here <en/resources/evaluation-hardware-and-software/evaluation-development-platforms/ace-software.html>`.
 
 .. image:: apollo_plugin_main_window.png
@@ -51,7 +51,7 @@
 
 .. note::
 
    The following commands assume that the profile has been generated and saved
    with the ``new_profile.bin`` name.
 
 After generating the profile, copy the ``.bin`` file to the ``linux/lib/firmware`` location:
@@ -79,7 +79,7 @@
    $cat arch/arch/microblaze/configs/adi_mb_defconfig | grep 'CONFIG_EXTRA_FIRMWARE='
     CONFIG_EXTRA_FIRMWARE="new_profile.bin APOLLO_FW_CPU1_B.bin <...>"
 
 You can then follow the :ref:`Linux kernel build flow <ad9084_ebz microblaze linux>`
 to build the kernel and boot it on the board.
 
 For Versal carriers (:xilinx:`VCK190`/:xilinx:`VPK180`)
@@ -97,10 +97,10 @@
   $cat arch/arm64/configs/adi_versal_defconfig | grep 'CONFIG_EXTRA_FIRMWARE='
   CONFIG_EXTRA_FIRMWARE="new_profile.bin APOLLO_FW_CPU1_B.bin <...>"
 
-You can then follow the :ref:`Linux kernel build flow <ad9084_ebz versal linux>`
+You can then follow the :ref:`Linux kernel build flow <ad9084 versal linux>`
 to build the kernel and boot it on the board.
 
 For Intel Agilex 7 I-Series (`FM87 <https://www.intel.com/content/www/us/en/products/details/fpga/development-kits/agilex/si-agi027.html>`__)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Update the ``arch/arm64/configs/adi_zynqmp_defconfig`` file to include
@@ -115,7 +115,7 @@
   $cat arch/arm64/configs/adi_zynqmp_defconfig | grep 'CONFIG_EXTRA_FIRMWARE='
   CONFIG_EXTRA_FIRMWARE="new_profile.bin APOLLO_FW_CPU1_B.bin <...>"
 
-You can then follow the :ref:`Linux kernel build flow <ad9084_ebz agilex linux>`
+You can then follow the :ref:`Linux kernel build flow <ad9084 agilex linux>`
 to build the kernel and boot it on the board.
 
 .. important::

docs/solutions/reference-designs/eval-ad9084/index.rst

@@ -0,0 +1,169 @@
+.. _ad9084:
+
+AD9084-FMCA-EBZ (Apollo)
+===============================================================================
+
+.. image:: ../images/ad9084.png
+   :align: left
+   :width: 150
+
+Overview
+-------------------------------------------------------------------------------
+
+The :adi:`EVAL-AD9084` is an FMC radio card for the :adi:`AD9084`,
+mixed signal front end (MxFE®), highly integrated device with a 16-bit,
+28 GSPS maximum sample rate, RF digital-to-analog converter (DAC) core,
+and 12-bit, 20 GSPS maximum sample rate, RF analog-to-digital converter
+(ADC) core. The :adi:`AD9084` supports four transmit channels and four
+receive channels.
+
+The :adi:`AD9084` is well suited for applications requiring both wideband ADCs
+and DACs to process signal(s) having wide instantaneous bandwidth. The device
+features a 48 lane, 32.5 Gbps JESD204C or 20 Gbps JESD204B data transceiver
+port, an on-chip clock multiplier, and a digital signal processing (DSP)
+capability targeted at either wideband or multiband, direct to RF applications.
+
+The :adi:`AD9084` also features a bypass mode that allows the full bandwidth
+capability of the ADC and/or DAC cores to bypass the DSP data-paths. The device
+also features low latency loopback and frequency hopping modes targeted at
+phased array radar systems and electronic warfare applications.
+
+Features:
+
+- Reconfigurable mixed signal platform design
+- 4 16-bit RF DACs and 4 12-bit RF ADCs (4T4R)
+- Usable RF analog bandwidth to 18GHz
+- Fast detect with low latency for fast AGC control
+- Spectrum sniffer and monitor
+- Signal monitor for slow AGC control
+- Multiple loopback (ADC to DAC)
+- Power amplifier downstream protection circuitry
+- Maximum DAC/ADC sample rate up to 28GSPS/20GSPS
+- Versatile digital features
+- Maximum instantaneous bandwidth of 10GHz per channel
+  (2T2R)
+- Programmable FIR filters at full ADC and DAC sample rates
+- Configurable fine and coarse DDCs and DUCs
+- Fast frequency hopping with profiles
+- Dynamic configuration through SPI, HSCI, GPIO, or external
+  trigger (TRIG)
+- Programmable fractional data rate resampler from 1× to 2×
+- JESD204B and JESD204C: 20Gbps and 28.21Gbps
+- On-chip temperature monitoring unit
+- Package: 24mm × 26mm, 899-ball BGA with 0.8mm pitch
+
+Applications:
+
+- Radar and phase array systems
+- Seeker front end
+- Tactical defense radio infrastructure
+- Electronic warfare and signal intelligence
+- Wireless communications infrastructure
+- Wireless communications test (5G mmWave, 5G C band, backhaul)
+
+.. image:: ../images/eval_ad9084.png
+   :align: center
+   :width: 600px
+
+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:`AD9084`, we recommend to use the
+:adi:`EVAL-AD9084` evaluation board.
+
+
+Table of Contents
+-------------------------------------------------------------------------------
+
+#. Using the evaluation board/full stack reference design that we offer:
+
+   #. :ref:`ad9084 user-guide` - what you need to know about the
+      evaluation board
+   #. :ref:`ad9084 prerequisites` - what you need to get started with the setup
+   #. :ref:`ad9084 quickstart`:
+
+      #. Using the :ref:`Agilex 7/ SoC I-Series <ad9084 quickstart agilex>`
+      #. Using the :ref:`VCU118/VCU128/ Virtex UltraScale+ <ad9084 quickstart microblaze>`
+      #. Using the :ref:`VCK190/VPK180/ Versal ACAP  <ad9084 quickstart versal>`
+
+#. Use the board to better understand the :adi:`AD9084`
+
+      #. :external+adi-kuiper-gen:doc:`Configure a SD Card <hardware-configuration>`
+      #. :external+adi-kuiper-gen:doc:`Update the SD Card <repositories>`
+      #. :ref:`AD9084 (Apollo) Profile Generator <ad9084 profile-generator>`
+      #. :ref:`Running a new JESD mode on hardware <ad9084 quickstart new_usecase>`
+
+   #. Linux Applications
+
+      #. :ref:`IIO Oscilloscope <ad9084 iio-oscilloscope>` with:
+
+         - :ref:`AD9084 Plugin <ad9084 iio-oscilloscope-plugin>`
+
+      #. :dokuwiki:`FRU EEPROM Utility <resources/eval/user-guides/ad-fmcomms1-ebz/software/linux/applications/fru_dump>`
+
+#. Design with the AD9084
+
+   #. :ref:`ad9084 block-diagram`
+
+      #. :adi:`AD9084 Product page <AD9084>`
+      #. `Full Datasheet and chip design package <TODO>`__
+
+   #. Design a custom AD9084 based platform
+
+      #. Linux software
+
+         .. #. `AD9084 Linux Device Driver <TODO>`__
+
+            .. #. `AD9084 Device Driver Customization <TODO>`__
+
+         #. :dokuwiki:`JESD204 (FSM) Interface Linux Kernel Framework <resources/tools-software/linux-drivers/jesd204/jesd204-fsm-framework>`
+         #. :dokuwiki:`AXI-DMAC DMA Controller Linux Driver <resources/tools-software/linux-drivers/axi-dmac>`
+         #. :dokuwiki:`JESD204B Transmit Linux Driver <resources/tools-software/linux-drivers/jesd204/axi_jesd204_tx>`
+
+            #. :dokuwiki:`JESD204B Status Utility <resources/tools-software/linux-software/jesd_status>`
+
+         #. :dokuwiki:`JESD204B Receive Linux Driver <resources/tools-software/linux-drivers/jesd204/axi_jesd204_rx>`
+
+            #. :dokuwiki:`JESD204B Status Utility <resources/tools-software/linux-software/jesd_status>`
+
+         #. :dokuwiki:`JESD204B/C AXI_ADXCVR Highspeed Transceivers Linux Driver <resources/tools-software/linux-drivers/jesd204/axi_adxcvr>`
+
+            #. :dokuwiki:`JESD204 Eye Scan <resources/tools-software/linux-software/jesd_eye_scan>`
+
+         #. :dokuwiki:`AXI ADC HDL Linux Driver <resources/tools-software/linux-drivers/iio-adc/axi-adc-hdl>`
+         #. :dokuwiki:`AXI DAC HDL Linux Driver <resources/tools-software/linux-drivers/iio-dds/axi-dac-dds-hdl>`
+
+      .. #. :dokuwiki:`HDL Reference Design <resources/eval/user-guides/ad9084/reference_hdl>` which you must use in your FPGA.
+
+.. #. `Help and Support <TODO>`__
+
+Pre-requisites and quickstart
+-------------------------------------------------------------------------------
+
+.. toctree::
+   :caption: The prerequisites and quickstart guides are provided at:
+   :titlesonly:
+   :maxdepth: 1
+
+   user-guide
+   prerequisites
+   quickstart/index
+
+.. _ad9084 block-diagram:
+
+Functional Block Diagram
+-------------------------------------------------------------------------------
+
+.. image:: ../images/apollo_block_diagram.png
+   :width: 600px
+
+Warning
+-------------------------------------------------------------------------------
+
+.. esd-warning::

docs/solutions/reference-designs/ad9084_ebz/prerequisites.rst → docs/solutions/reference-designs/eval-ad9084/prerequisites.rst

@@ -1,16 +1,17 @@
-.. _ad9084_ebz prerequisites:
+.. _ad9084 prerequisites:
 
 Prerequisites
-=============
+===============================================================================
+
 
 What you need, depends on what you are trying to do. As a minimum, you need to
 start out with:
 
-#. The :adi:`AD9084-FMCA-EBZ`` evaluation card.
+#. The :adi:`EVAL-AD9084` evaluation card.
 #. A carrier platform. ADI does not offer these boards for sale or loan, getting
    one yourself is normal part of development or evaluation of the AD9084.
 
-    - :ref:`See the supported carriers <ad9084_ebz carriers>`.
+    - :ref:`See the supported carriers <ad9084 carriers>`.
     - The carrier may require one or more `FMC+ riser cards <https://www.samtec.com/kits/optics-fpga/fmcp-extender/>`__.
 
 #. Analysis | Control | Evaluation (ACE) software with the AD9084 plugin installed.
@@ -30,5 +31,4 @@ start out with:
 #. 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).
-
 #. RF Test equipment.