solutions/reference-design/ad57xx-ardz: added docs for ad57xx

docs/solutions/reference-designs/ad57xx-ardz/index.rst

@@ -0,0 +1,155 @@
+.. _ad57xx:
+
+EVAL-AD57XXARDZ
+===============
+
+Family of Precision, Single-Channel output DACs
+
+.. .. image:: images/ad57xx_chip.png
+      :align: left
+      :width: 150
+
+Overview
+-------------------------------------------------------------------------------
+
+The :adi:`EVAL-AD5780ARDZ` facilitates fast prototyping of the
+:adi:`AD5780` circuit, and can be substituted with either the
+:adi:`AD5760` or :adi:`AD5790`, which must be ordered separately.
+Similarly, the :adi:`EVAL-AD5781ARDZ` and :adi:`EVAL-AD5791ARDZ`
+come with the :adi:`AD5781` and :adi:`AD5791` respectively.
+
+The :adi:`AD5790`, :adi:`AD5791`, :adi:`AD5760`, :adi:`AD5780`
+and :adi:`AD5781` are a family of precision, single-channel
+voltage output DACs, with resolutions from 16-bits up to 20-bits.
+They offer guaranteed monotonic operation, and low nonlinearity
+(down to 0.5 LSB INL and DNL)
+
+The evaluation boards provide an on-board -14 V and +14 V dual
+power supply. These evaluation boards also utilize external
+reference boards with an output voltage of +10 V and -10 V. The
+eval boards are connected to the carrier board through the
+Arduino Shield connector.
+
+Features:
+
+- Precision, single-channel voltage output DACs
+- Resolution options from 16 bits to 20 bits
+- Guaranteed monotonic operation
+- Low integral and differential nonlinearity
+  (down to 0.5 LSB INL and DNL, device dependent)
+- Buffered voltage outputs
+- Wide bipolar output voltage range support
+- External precision reference input
+- SPI-compatible serial interface
+- Low noise and low glitch performance
+- Industrial temperature range operation
+
+Applications:
+
+- Medical instrumentation
+- Test and measurement equipment
+- Industrial control systems
+- Scientific instrumentation
+- Aerospace and defense instrumentation
+- Data acquisition systems
+- Precision DC sources
+- Digital gain and offset adjustment
+- Power supply control and calibration
+
+.. grid::
+   :widths: 50% 50%
+
+   .. figure:: images/eval_ad5781ardz_angle.jpg
+      :width: 300
+
+      EVAL-AD5781ARDZ
+
+   .. figure:: images/eval_ad5780ardz_top.jpg
+      :width: 400
+
+      EVAL-AD5780ARDZ
+
+.. 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.
+
+To better understand the :adi:`AD5790` /:adi:`AD5791`
+/:adi:`AD5760` /:adi:`AD5780` /:adi:`AD5781`, we recommend to
+use the :adi:`EVAL-AD5780ARDZ` /:adi:`EVAL-AD5781ARDZ`
+/:adi:`EVAL-AD5791ARDZ` evaluation boards.
+
+Table of contents
+-------------------------------------------------------------------------------
+
+#. Using the evaluation board/full stack reference design that
+   we offer:
+
+    #. :ref:`AD57xx user-guide <ad57xx user-guide>` - what you
+        need to know about the evaluation board
+    #. :ref:`Prerequisites <ad57xx prerequisites>` - what you
+        need to get started
+    #. :ref:`Quick start guides <ad57xx-ardz quickstart>`:
+
+        #. Using the :ref:`AD57xx on Cora Z7S <ad57xx-ardz quickstart coraz7s>`
+        #. Using the :ref:`AD57xx on DE10-Nano <ad57xx-ardz quickstart de10nano>`
+
+    #. Configure an SD Card with
+       :external+kuiper:doc:`Kuiper <index>`
+
+    #. linux Applications
+
+        #. :ref:`iio-oscilloscope`
+
+#. Design with the :adi:`AD5790` /:adi:`AD5791` /:adi:`AD5760`
+   /:adi:`AD5780` /:adi:`AD5781`:
+
+    - :ref:`ad57xx block-diagrams`
+        #. :adi:`AD5780 product page <ad5780>`
+        #. :adi:`AD5781 product page <ad5781>`
+        #. :adi:`AD5790 product page <ad5790>`
+        #. :adi:`AD5791 product page <ad5791>`
+        #. :adi:`AD5760 product page <ad5760>`
+
+    - Resources for designing a custom AD57xx-based platform
+
+    #. For linux software:
+
+        - About the device driver:
+
+            - :git-linux:`AD5791 IIO DAC linux Driver <drivers/iio/dac/ad5791.c>`
+
+    #. For no-OS software:
+
+        - About the no-OS driver:
+
+            - :git-no-os:`AD5791 no-OS driver source code <drivers/dac/ad5791/ad5791.c>`
+
+.. _ad57xx block-diagrams:
+
+Block diagrams
+-------------------------------------------------------------------------------
+
+The HDL block diagrams for this project are maintained in the
+HDL repository:
+
+- :external+hdl:ref:`ad57xx_ardz`
+
+More Information and Useful Links
+-------------------------------------------------------------------------------
+
+- :adi:`EVAL-AD5780ARDZ`
+- :adi:`EVAL-AD5781ARDZ`
+- :adi:`EVAL-AD5791ARDZ`

docs/solutions/reference-designs/ad57xx-ardz/prerequisites.rst

@@ -0,0 +1,61 @@
+.. _ad57xx 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 AD57xx-based evaluation boards:
+   :adi:`EVAL-AD5780ARDZ`, :adi:`EVAL-AD5781ARDZ`,
+   or :adi:`EVAL-AD5791ARDZ`.
+#. A voltage reference daughter board (EV-ADR445-REFZ is
+   included with each evaluation kit; EV-LTC6655-REFZ,
+   EV-LTZ1000-REFZ, or EV-ADR1001-REFZ are available
+   separately for improved performance).
+#. An FPGA carrier platform. Our recommended ones can be found
+   :ref:`here <ad57xx-ardz 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:
+
+      - HDMI or DisplayPort monitor
+      - USB Keyboard
+      - USB Mouse
+
+   #. for the FPGA only solutions, this includes:
+
+      - LAN cable (Ethernet)
+      - Host PC (Windows or linux)
+
+#. Internet connection (without proxies makes things much
+   easier) to update the scripts/binaries on the SD card
+   (firewalls are OK, proxies make things a pain).
+#. 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 controlling the
+DAC output and interfacing with the FPGA, we use the following:
+
+#. :external+scopy:doc:`Scopy <index>` v2.0 or later (must
+   contain the IIO plugin)
+
+.. note::
+
+   :adi:`ADI <>` does not offer FPGA carrier platforms for sale
+   or loan; getting one yourself is the normal part of
+   development or evaluation.