From ad09d1a1e80a3211c5f2a9a9b7fa4d6772e44e6c Mon Sep 17 00:00:00 2001 From: Pop Ioan Daniel Date: Fri, 22 Nov 2024 11:06:08 +0200 Subject: [PATCH] docs: Update project documentation Signed-off-by: Pop Ioan Daniel --- .../ad7405_fmc/ad7405_zed_cmos_diagram.svg | 190 ++++++++++++------ .../ad7405_fmc/ad7405_zed_lvds_diagram.svg | 39 ++-- docs/projects/ad7405_fmc/index.rst | 44 ++-- 3 files changed, 166 insertions(+), 107 deletions(-) diff --git a/docs/projects/ad7405_fmc/ad7405_zed_cmos_diagram.svg b/docs/projects/ad7405_fmc/ad7405_zed_cmos_diagram.svg index 27a958a520..7b51e67a6b 100644 --- a/docs/projects/ad7405_fmc/ad7405_zed_cmos_diagram.svg +++ b/docs/projects/ad7405_fmc/ad7405_zed_cmos_diagram.svg @@ -2,15 +2,16 @@ + inkscape:current-layer="layer1" + inkscape:showpageshadow="2" + inkscape:deskcolor="#d1d1d1" /> + + + + + + + + + + @@ -637,12 +693,12 @@ style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:5.29167px;line-height:1.25;font-family:Arial;-inkscape-font-specification:'Arial Bold';text-align:center;text-anchor:middle;fill:#000000;fill-opacity:0.858696;stroke-width:0.264583px" id="tspan3725">ZedBoard @@ -651,7 +707,7 @@ id="rect4488" width="7.645824" height="84.076927" - x="188.3338" + x="196.27119" y="92.270683" inkscape:export-xdpi="224.36" inkscape:export-ydpi="224.36" @@ -660,7 +716,7 @@ xml:space="preserve" style="font-style:normal;font-weight:normal;font-size:3.175px;line-height:0%;font-family:Arial;letter-spacing:0px;word-spacing:0px;display:inline;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;shape-rendering:crispEdges;enable-background:new" x="-156.85475" - y="193.74075" + y="201.67815" id="text4491" transform="rotate(-90)" inkscape:export-xdpi="224.36" @@ -669,7 +725,7 @@ sodipodi:role="line" id="tspan4493" x="-156.85475" - y="193.74075" + y="201.67815" style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:4.63021px;line-height:1.25;font-family:Arial;-inkscape-font-specification:'Arial Bold';stroke-width:0.264583px">FMC CONNECTOR adc_clk 16 + width="40.022354" + height="12.661736" + x="107.17424" + y="119.35708" + inkscape:label="rect19131" /> util_dec256sinc24b + style="stroke-width:0.246507" + x="115.21629" + y="130.23114">sinc3 filter + width="55.060951" + height="24.375071" + x="99.62545" + y="110.57105" /> UTIL_DEC256SINC24B + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:3.15252px;font-family:Arial;-inkscape-font-specification:'Arial, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#000000;fill-opacity:1;stroke-width:0.264583" + x="117.3166" + y="116.88174">AXI_AD7405 + d="m 196.19734,125.47785 h -38.8062" + style="fill:none;stroke:#000000;stroke-width:0.538949;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-end:url(#marker1216-71);shape-rendering:crispEdges" /> adc_data ADC clock=20MHz + y="165.88783">ADC clock=50MHz + diff --git a/docs/projects/ad7405_fmc/ad7405_zed_lvds_diagram.svg b/docs/projects/ad7405_fmc/ad7405_zed_lvds_diagram.svg index 3360f08e58..421a1c3d92 100644 --- a/docs/projects/ad7405_fmc/ad7405_zed_lvds_diagram.svg +++ b/docs/projects/ad7405_fmc/ad7405_zed_lvds_diagram.svg @@ -7,8 +7,8 @@ viewBox="0 0 161.18021 164.51407" version="1.1" id="svg5" - sodipodi:docname="ad7405_zed_diff_block_diagram.svg" - inkscape:version="1.1.2 (0a00cf5339, 2022-02-04)" + sodipodi:docname="ad7405_zed_lvds_diagram.svg" + inkscape:version="1.3 (0e150ed6c4, 2023-07-21)" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" xmlns="http://www.w3.org/2000/svg" @@ -23,15 +23,17 @@ inkscape:pagecheckerboard="0" inkscape:document-units="mm" showgrid="false" - inkscape:zoom="11.844781" - inkscape:cx="219.37932" - inkscape:cy="518.92052" + inkscape:zoom="1.4805976" + inkscape:cx="414.02201" + inkscape:cy="324.19341" inkscape:window-width="1920" - inkscape:window-height="990" - inkscape:window-x="0" - inkscape:window-y="28" + inkscape:window-height="1122" + inkscape:window-x="-8" + inkscape:window-y="1342" inkscape:window-maximized="1" - inkscape:current-layer="layer1" /> + inkscape:current-layer="layer1" + inkscape:showpageshadow="2" + inkscape:deskcolor="#d1d1d1" /> ADC clock=20MHz + y="177.97098">ADC clock=50MHz + diff --git a/docs/projects/ad7405_fmc/index.rst b/docs/projects/ad7405_fmc/index.rst index 9ad3f244b3..f3dc722437 100644 --- a/docs/projects/ad7405_fmc/index.rst +++ b/docs/projects/ad7405_fmc/index.rst @@ -10,11 +10,11 @@ The :adi:`EVAL-AD7405` is a full-featured evaluation board designed to allow the user to easily evaluate all features of the :adi:`AD7405` isolated analog-to-digital converter (ADC). -The provided HDL reference design supports the :adi:`AD7405` , :adi:`AD7403` -and :adi:`ADuM7701` devices. +The provided HDL reference design supports the :adi:`AD7405`, :adi:`AD7403` and +:adi:`ADuM7701` devices. One of the main differences between these devices is the type of the digital -data lines. In the case of :adi:`ADuM7701` and :adi:`AD7403`, it is -single-ended, and for :adi:`AD7405` is differential. +data lines. In the case of :adi:`ADuM7701` and :adi:`AD7403`, it is single-ended, +and for :adi:`AD7405` is differential. Supported boards ------------------------------------------------------------------------------- @@ -91,38 +91,11 @@ added to the base address from HDL (see more at :ref:`architecture`). ==================== =============== Instance Zynq/Microblaze ==================== =============== +axi_ad7405 0x44A0_0000 axi_ad7405_dma 0x44A3_0000 axi_adc_clkgen 0x44A4_0000 ==================== =============== -GPIOs -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. list-table:: - :widths: 25 20 20 20 15 - :header-rows: 2 - - * - GPIO signal - - Direction - - HDL GPIO EMIO - - Software GPIO - - Software GPIO - * - - - (from FPGA view) - - - - Zynq-7000 - - Zynq MP - * - filter_reset - - INOUT - - 48 - - 102 - - 124 - * - decimation_ratio[15:0] - - INOUT - - 47:32 - - 101:86 - - 125:110 - Interrupts ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -196,6 +169,9 @@ HDL related * - IP name - Source code link - Documentation link + * - AXI_AD7405 + - :git-hdl:`library/axi_ad7405` + - --- * - AXI_CLKGEN - :git-hdl:`library/axi_clkgen` - :ref:`axi_clkgen` @@ -223,11 +199,15 @@ HDL related * - UTIL_I2C_MIXER - :git-hdl:`library/util_i2c_mixer` - --- + * - UTIL_CDC + - :git-hdl:`library/util_cdc` + - --- Software related ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * No-OS driver at :git-no-os:`legacy/adum7701_fmc` +* Linux driver at :git-linux:`drivers/iio/adc/admc_adc.c` .. include:: ../common/more_information.rst