Add eval-ad488x-fmc doc pages

docs/solutions/reference-designs/eval-ad488x-fmc/index.rst

@@ -0,0 +1,140 @@
+.. _ad488x:
+
+EVAL-AD488X-FMC
+===============================================================================
+
+Evaluating the AD488x Family of Dual-Channel, Low Noise, High Speed SAR ADC
+
+.. image:: images/ad4880_chip.png
+   :align: left
+   :width: 150
+
+.. image:: images/ad4884_chip.png
+   :align: left
+   :width: 150
+
+.. clear-content::
+
+Overview
+-------------------------------------------------------------------------------
+
+The :adi:`EVAL-AD488X-FMC <eval-ad4884>` is an FMC evaluation board designed
+to demonstrate the performance of the :adi:`AD4880` and :adi:`AD4884`
+dual-channel, low noise, high speed successive approximation register (SAR)
+analog-to-digital converters (ADC) with integrated fully differential drivers
+(FDA) and gain setting resistors.
+
+The evaluation board is designed for use with the Digilent ZedBoard via the FMC
+connector. The ZedBoard uses a Xilinx Zynq7000 system on chip (SoC) that runs
+Analog Devices Kuiper Linux and LIBIIO included on the SD card supplied in the
+evaluation board kit, enabling ADC configuration and data capture.
+
+Full specifications on the :adi:`AD4880` and :adi:`AD4884` are available in the
+respective data sheets and must be consulted with this user guide when using
+the :adi:`EVAL-AD488X-FMC <eval-ad4884>` evaluation board.
+
+Features:
+
+- Integrated fully differential ADC drivers
+- Low-voltage digital signaling (LVDS) data output interface.
+- Analog-to-digital converter (ADC) configuration via serial
+  peripheral interface (SPI).
+- Internal or external generation of 1.1V regulated supply rails.
+- Sampling rate capability between 1.25MSPS and 20MSPS.
+- FMC form factor for easy connection to FPGA carrier boards
+
+Applications:
+
+- Digital imaging
+- Cell analysis
+- Spectroscopy
+- High speed data acquisition
+- Digital control loops, hardware in the loop
+- Power quality analysis
+- Source measurement units
+- Nondestructive test
+
+.. figure:: images/eval_ad488x_board.png
+   :width: 800
+
+   EVAL-AD488X-FMC
+
+.. toctree::
+   :hidden:
+
+   user-guide
+   prerequisites
+   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.
+
+Table of contents
+-------------------------------------------------------------------------------
+
+#. Using the evaluation board/full stack reference design that we offer:
+
+   #. :ref:`Prerequisites <ad488x prerequisites>` - what you need to get
+      started
+   #. :ref:`Quick start guides <ad488x quickstart>`:
+
+      #. Using the :ref:`ZedBoard <ad488x quickstart zed>`
+
+   #. Configure an SD Card with :external+kuiper:doc:`Kuiper <index>`
+
+   #. Linux Applications
+
+      #. :ref:`iio-oscilloscope`
+
+#. Design with the AD488X
+
+   - :ref:`ad488x block-diagram`
+
+     - :adi:`EVAL-AD4884 product page <en/resources/evaluation-hardware-and-software/evaluation-boards-kits/eval-ad4884.html>`
+     - :adi:`AD4880 Datasheet <media/en/technical-documentation/data-sheets/ad4880.pdf>`
+     - :adi:`AD4884 Datasheet <media/en/technical-documentation/data-sheets/ad4884.pdf>`
+
+   - Resources for designing a custom AD488X-based platform
+
+     #. For Linux software:
+
+        #. `AD488X IIO ADC Linux Driver
+           <https://github.com/analogdevicesinc/linux/tree/main/drivers/iio/adc/ad4080.c>`__
+
+     #. `HDL reference design
+        <https://analogdevicesinc.github.io/hdl/projects/ad4880_fmc_evb/index.html>`__
+
+#. :ref:`Help and Support <help-and-support>`
+
+.. _ad488x block-diagram:
+
+Block diagram
+-------------------------------------------------------------------------------
+
+.. figure:: images/ad4884_block_diagram.png
+   :align: center
+   :width: 800
+
+   EVAL-AD488X-FMC Block Diagram
+
+More Information and Useful Links
+-------------------------------------------------------------------------------
+
+- :adi:`AD4880 Product Page <AD4880>`
+- :adi:`AD4884 Product Page <AD4884>`
+
+Warning
+-------------------------------------------------------------------------------
+
+.. esd-warning::
+
+Help and support
+-------------------------------------------------------------------------------
+
+Please go to :ref:`Help and Support <help-and-support>` page.

docs/solutions/reference-designs/eval-ad488x-fmc/prerequisites.rst

@@ -0,0 +1,64 @@
+.. _ad488x 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 AD488X-based evaluation board:
+   :adi:`EVAL-AD488X-FMC <eval-ad4884>`
+#. An FPGA carrier platform. Our recommended one can be found
+   :ref:`here <ad488x 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, 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 16 GB 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), 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.

docs/solutions/reference-designs/eval-ad488x-fmc/quickstart/index.rst

@@ -0,0 +1,61 @@
+.. _ad488x quickstart:
+
+Quickstart
+===============================================================================
+
+The Quick Start Guides provide simple step by step instructions on how to do
+an initial system setup for the :adi:`EVAL-AD488X-FMC <eval-ad4884>`
+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::
+
+   On ZED <zed>
+
+.. _ad488x carriers:
+
+Supported carriers
+-------------------------------------------------------------------------------
+
+The :adi:`EVAL-AD488X-FMC <eval-ad4884>`, 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-AD488X-FMC
+   - - `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
+     - No
+
+Hardware setup
+-------------------------------------------------------------------------------
+
+On most carriers, the :adi:`EVAL-AD488X-FMC <eval-ad4884>` board
+connects to the FMC LPC connector (unless otherwise noted). 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.
+
+ZED + EVAL-AD488X-FMC
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Go to :ref:`the setup guide <ad488x quickstart zed>`.