Created documentation for HMCAD15xx-EBZ project

docs/solutions/reference-designs/hmcad15xx_ebz/index.rst

@@ -0,0 +1,90 @@
+.. _hmcad15xx-ebz:
+
+HMCAD15XX-EBZ
+===============================================================================
+
+High Speed Multi-Mode 8/12/14-Bit 1000/640/105 MSPS A/D Converter
+
+Overview
+-------------------------------------------------------------------------------
+The :adi:`HMCAD1511-EBZ` / :adi:`HMCAD1520-EBZ` are high-speed analog-to-digital
+converter (ADC) evaluation boards designed for multichannel data acquisition
+applications. The boards feature a multi-mode ADC that supports 8-bit, 12-bit,
+and 14-bit resolution modes with sampling rates between 105-1000 MSPS. They 
+provide flexible input configuration options with both single-ended and 
+differential analog inputs, enabling direct interfacing with a wide variety of
+RF and baseband signal sources. The boards include integrated signal 
+conditioning and timing circuitry for seamless operation. Hardware and software
+controls enable users to optimize the ADC performance for their specific 
+application requirements. Software control is accessible through the Linux 
+industrial input/output (IIO) framework.
+
+Features:
+
+- Both chips feature:
+    - 8 bit resolution.
+    - Single/Dual/Quad channel modes with 1000/500/250 MSPS.
+- The HMCAD1520 features:
+    - 8/12/14 bit resolutions
+    - Dual 8-bit Quad Channel Mode
+    - 12-bit resolution Single/Dual/Quad channel modes with 640/320/160 MSPS
+    - 14-bit precision resolution Quad channel mode with 105 MSPS
+
+Applications:
+
+- Precision Oscilloscopes
+- Satellite Receivers
+- Hi-End Ultrasound
+- Spectrum Analyzers
+
+.. image:: ./images/HMCAD1520-EBZ.webp
+   :align: center
+   :width: 500
+
+.. 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 EngineerZone 
+forums, but before that, please make sure you read our documentation thoroughly.
+
+To better understand the :adi:`HMCAD1511` / :adi:`HMCAD1520`, we recommend to
+use the  :adi:`HMCAD1511-EBZ` / :adi:`HMCAD1520-EBZ` evaluation board.
+
+Table of contents
+-------------------------------------------------------------------------------
+#. Using the evaluation board/full stack reference design that we offer:
+    #. :ref:`User Guide <hmcad15xx user-guide>`
+    #. :ref:`Prerequisites <hmcad15xx prerequisites>` - what you need to get
+       started
+    #. :ref:`Quick start guide <hmcad15xx quickstart>`
+        #. Using the :ref:`ZedBoard <hmcad15xx zed>`
+    #. Configure an SD Card with :external+kuiper:doc:`Kuiper <index>`
+    #. Linux Applications
+        #. :ref:`iio-oscilloscope`
+#. Design with the HMCAD1511/HMCAD1520
+    - :ref:`Block Diagram <hmcad15xx block_diagram>`
+        - :adi:`HMCAD1511 product page <HMCAD1511>`
+        - :adi:`HMCAD1520 product page <HMCAD1520>`
+
+.. _hmcad15xx block_diagram:
+
+Block Diagram
+-------------------------------------------------------------------------------
+
+.. image:: ./images/hmcad1520_block_diagram.png
+   :align: center
+   :width: 800
+
+Warning
+-------------------------------------------------------------------------------
+
+.. esd-warning::

docs/solutions/reference-designs/hmcad15xx_ebz/prerequisites.rst

@@ -0,0 +1,53 @@
+.. _hmcad15xx 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 HMCAD1511/HMCAD1520-based evaluation board:
+   :adi:`HMCAD1511-EBZ/HMCAD1520-EBZ <HMCAD1520-EBZ>`
+#. An FPGA carrier platform. Our recommended ones can be found
+   :ref:`here <hmcad15xx carriers>`.
+#. Power supply for your carrier.
+#. 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)
+      - Micro-USB (UART)
+      - Host PC (Windows or Linux)
+
+#. 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).
+#. Signal Generator
+#. SMA male to BNC male cable
+#. External 1GHz clock source if working with the :adi:`HMCAD1520-EBZ` + extra 
+   SMA male to SMA male cable because the :adi:`HMCAD1520-EBZ` does not include
+   an onboard crystal clock like the :adi:`HMCAD1511-EBZ`
+#. An SD card with at least 16GB of memory.
+
+Software prerequisites
+-------------------------------------------------------------------------------
+
+Normally, for basic functionalities regarding visualizing the data received
+from the FPGA, we use the following:
+
+#. :external+scopy:doc:`Scopy <index>` v2.2 or later
+   (must contain the ADC 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.

docs/solutions/reference-designs/hmcad15xx_ebz/quickstart/index.rst

@@ -0,0 +1,67 @@
+.. _hmcad15xx quickstart:
+
+Quick start
+===============================================================================
+
+The Quick start guides provide simple step by step instructions on how to do an
+initial system setup for the :adi:`HMCAD1511-EBZ/HMCAD1520-EBZ <HMCAD1520-EBZ>`
+boards 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 ZedBoard <zed>
+
+.. _hmcad15xx carriers:
+
+Supported carriers
+-------------------------------------------------------------------------------
+
+The :adi:`HMCAD1511-EBZ/HMCAD1520-EBZ <HMCAD1520-EBZ>`, is, by definition a
+"FPGA mezzanine card" (FMC); that means it needs a carrier to plug into.
+
+The carriers we support are listed below, as well as the FMC port where to
+connect the evaluation board:
+
+.. list-table::
+   :header-rows: 1
+
+   - - FPGA board
+     - HMCAD1520-EBZ
+     - HMCAD1511-EBZ
+   - - `ZedBoard <https://digilent.com/shop/zedboard-zynq-7000-arm-fpga-soc-development-board/>`_
+     - FMC 
+     - FMC 
+
+Supported Environments
+-------------------------------------------------------------------------------
+
+The supported OS are:
+
+.. list-table::
+   :header-rows: 1
+
+   - - FPGA board
+     - HDL
+     - Linux software
+     - No-OS software
+   - - `ZedBoard <https://digilent.com/shop/zedboard-zynq-7000-arm-fpga-soc-development-board/>`_
+     - Yes
+     - Yes
+     - ---
+
+Hardware Setup
+-------------------------------------------------------------------------------
+
+On `ZedBoard <https://digilent.com/shop/zedboard-zynq-7000-arm-fpga-soc-development-board/>`_ 
+the board connects to the FMC connector. The carrier setup requires power,
+UART(115200), Ethernet (Linux), HDMI (optional). The typical setup is shown
+below.
+
+ZedBoard + HMCAD1511-EBZ/HMCAD1520-EBZ
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. image:: ../images/hmcad1520_zed_setup.jpg
+   :width: 600
+
+