Skip to content

Commit

Permalink
Deploying to gh-pages from @ 27e3f5d 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
jakubcabal committed Jan 31, 2024
1 parent c6a663f commit 2bdcdfc
Show file tree
Hide file tree
Showing 194 changed files with 703 additions and 188 deletions.
45 changes: 45 additions & 0 deletions devel/_sources/ndk_cards/amd/alveo-u55c/readme.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
.. _card_alveo_u55c:

AMD Alveo U55C
--------------

- Card information:
- Vendor: AMD/Xilinx
- Name: Alveo U55C
- Ethernet ports: 2x QSFP28
- PCIe conectors: Edge connector
- `FPGA Card Website <https://www.xilinx.com/products/boards-and-kits/alveo/u55c.html>`_
- FPGA specification:
- FPGA part number: ``xcu55c-fsvh2892-2L-e``
- Ethernet Hard IP: CMAC (100G Ethernet)
- PCIe Hard IP: USP

NDK firmware support
^^^^^^^^^^^^^^^^^^^^

- Ethernet cores that are supported in the NDK firmware:
- :ref:`CMAC in the Network Module <ndk_net_mod>`
- PCIe cores that are supported in the NDK firmware:
- :ref:`USP in the PCIe Module <ndk_pcie_mod>`
- See the ``<NDK-APP_root_directory>/ndk/card/alveo-u55c/config/card_conf.tcl`` file for supported PCIe configurations.
- Makefile targets for building the NDK firmware (valid for NDK-APP-Minimal, may vary for other apps):
- Use ``make 100g2`` command for firmware with 2x100GbE (default).
- Support for booting the NDK firmware using the nfb-boot tool:
- NO, use JTAG (see below).

Programming the device
^^^^^^^^^^^^^^^^^^^^^^

1. Buld the firmware using ``make`` as described above ("Generate bitstream" using Vivado GUI flow)
2. Connect USB cable to the JTAG interface of the card
3. Open Hardware manager in Vivado
4. Program the device

For more information, refer to the `Programming and debugging manual <https://docs.xilinx.com/r/2022.2-English/ug908-vivado-programming-debugging/Opening-the-Hardware-Manager?tocId=x0two8P7pmYkinePAp~Scg>`_
of the Vivado

.. note::
To build the NDK firmware for this card, you must have the Xilinx Vivado installed, including a valid license.

.. warning::
Ethernet interface has not been properly tested on this device, although CMACs can be included.
2 changes: 1 addition & 1 deletion devel/app-minimal.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
Minimal NDK Application Docs
</a>
<div class="version">
Git branch: devel, <br> Git hash: 83cc58d9
Git branch: devel, <br> Git hash: 27e3f5d0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion devel/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
Minimal NDK Application Docs
</a>
<div class="version">
Git branch: devel, <br> Git hash: 83cc58d9
Git branch: devel, <br> Git hash: 27e3f5d0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion devel/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
Minimal NDK Application Docs
</a>
<div class="version">
Git branch: devel, <br> Git hash: 83cc58d9
Git branch: devel, <br> Git hash: 27e3f5d0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion devel/ndk_cards/amd/alveo-u200/readme.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
Minimal NDK Application Docs
</a>
<div class="version">
Git branch: devel, <br> Git hash: 83cc58d9
Git branch: devel, <br> Git hash: 27e3f5d0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
Expand Down
218 changes: 218 additions & 0 deletions devel/ndk_cards/amd/alveo-u55c/readme.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,218 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en">
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>AMD Alveo U55C &mdash; Minimal NDK Application Docs documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/css/theme_overrides.css" />


<!--[if lt IE 9]>
<script src="../../../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/sphinx_highlight.js"></script>
<script src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
</head>

<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >



<a href="../../../index.html" class="icon icon-home">
Minimal NDK Application Docs
</a>
<div class="version">
Git branch: devel, <br> Git hash: 27e3f5d0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Application:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../app-minimal.html">Minimal NDK application</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Network Development Kit:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../ndk_core/doc/how_to_start.html">How to start</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../ndk_core/doc/terminology.html">NDK Terminology</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../ndk_core/intel/readme.html">NDK architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../ndk_core/doc/configuration.html">Configuration files and parameters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../ndk_core/doc/testing.html">NDK testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../ofm_doc/build/readme.html">Build System</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../ndk_core/doc/devtree.html">Device Tree</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../ndk_core/doc/faq.html">Frequently Asked Questions</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Supported cards:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../reflexces/agi-fh400g/readme.html">ReflexCES XpressSX AGI-FH400G</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../intel/dk-dev-1sdx-p/readme.html">Intel Stratix 10 DX FPGA DK</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../intel/dk-dev-agi027res/readme.html">Intel Agilex I-Series FPGA DK</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../silicom/fb4cgg3/readme.html">Silicom fb4CGg3&#64;VU9P</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../silicom/fb2cghh/readme.html">Silicom fb2CGhh&#64;KU15P</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../silicom/n6010/readme.html">Silicom N6010</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../bittware/ia-420f/readme.html">Bittware IA-420F</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">VHDL components:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../ofm_doc/base.html">Basic Tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../ofm_doc/ctrls.html">Controllers &amp; TSU</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../ofm_doc/mi.html">MI Tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../ofm_doc/mfb.html">MFB Tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../ofm_doc/mvb.html">MVB Tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../ofm_doc/nic.html">Network Tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../ofm_doc/pcie.html">PCIe Tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../ofm_doc/debug.html">Debug Tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../ofm_doc/ver.html">UVM Verification</a></li>
</ul>

</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../index.html">Minimal NDK Application Docs</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">AMD Alveo U55C</li>
<li class="wy-breadcrumbs-aside">
<a href="../../../_sources/ndk_cards/amd/alveo-u55c/readme.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<section id="amd-alveo-u55c">
<span id="card-alveo-u55c"></span><h1>AMD Alveo U55C<a class="headerlink" href="#amd-alveo-u55c" title="Permalink to this heading"></a></h1>
<ul class="simple">
<li><dl class="simple">
<dt>Card information:</dt><dd><ul>
<li><p>Vendor: AMD/Xilinx</p></li>
<li><p>Name: Alveo U55C</p></li>
<li><p>Ethernet ports: 2x QSFP28</p></li>
<li><p>PCIe conectors: Edge connector</p></li>
<li><p><a class="reference external" href="https://www.xilinx.com/products/boards-and-kits/alveo/u55c.html">FPGA Card Website</a></p></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>FPGA specification:</dt><dd><ul>
<li><p>FPGA part number: <code class="docutils literal notranslate"><span class="pre">xcu55c-fsvh2892-2L-e</span></code></p></li>
<li><p>Ethernet Hard IP: CMAC (100G Ethernet)</p></li>
<li><p>PCIe Hard IP: USP</p></li>
</ul>
</dd>
</dl>
</li>
</ul>
<section id="ndk-firmware-support">
<h2>NDK firmware support<a class="headerlink" href="#ndk-firmware-support" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><dl class="simple">
<dt>Ethernet cores that are supported in the NDK firmware:</dt><dd><ul>
<li><p><a class="reference internal" href="../../../ndk_core/intel/doc/eth.html#ndk-net-mod"><span class="std std-ref">CMAC in the Network Module</span></a></p></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>PCIe cores that are supported in the NDK firmware:</dt><dd><ul>
<li><p><a class="reference internal" href="../../../ndk_core/intel/doc/pcie.html#ndk-pcie-mod"><span class="std std-ref">USP in the PCIe Module</span></a></p></li>
<li><p>See the <code class="docutils literal notranslate"><span class="pre">&lt;NDK-APP_root_directory&gt;/ndk/card/alveo-u55c/config/card_conf.tcl</span></code> file for supported PCIe configurations.</p></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>Makefile targets for building the NDK firmware (valid for NDK-APP-Minimal, may vary for other apps):</dt><dd><ul>
<li><p>Use <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">100g2</span></code> command for firmware with 2x100GbE (default).</p></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>Support for booting the NDK firmware using the nfb-boot tool:</dt><dd><ul>
<li><p>NO, use JTAG (see below).</p></li>
</ul>
</dd>
</dl>
</li>
</ul>
</section>
<section id="programming-the-device">
<h2>Programming the device<a class="headerlink" href="#programming-the-device" title="Permalink to this heading"></a></h2>
<ol class="arabic simple">
<li><p>Buld the firmware using <code class="docutils literal notranslate"><span class="pre">make</span></code> as described above (“Generate bitstream” using Vivado GUI flow)</p></li>
<li><p>Connect USB cable to the JTAG interface of the card</p></li>
<li><p>Open Hardware manager in Vivado</p></li>
<li><p>Program the device</p></li>
</ol>
<p>For more information, refer to the <a class="reference external" href="https://docs.xilinx.com/r/2022.2-English/ug908-vivado-programming-debugging/Opening-the-Hardware-Manager?tocId=x0two8P7pmYkinePAp~Scg">Programming and debugging manual</a>
of the Vivado</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>To build the NDK firmware for this card, you must have the Xilinx Vivado installed, including a valid license.</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Ethernet interface has not been properly tested on this device, although CMACs can be included.</p>
</div>
</section>
</section>


</div>
</div>
<footer>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2024, CESNET z.s.p.o..</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.


</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
2 changes: 1 addition & 1 deletion devel/ndk_cards/amd/vcu118/readme.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
Minimal NDK Application Docs
</a>
<div class="version">
Git branch: devel, <br> Git hash: 83cc58d9
Git branch: devel, <br> Git hash: 27e3f5d0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion devel/ndk_cards/bittware/ia-420f/readme.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
Minimal NDK Application Docs
</a>
<div class="version">
Git branch: devel, <br> Git hash: 83cc58d9
Git branch: devel, <br> Git hash: 27e3f5d0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion devel/ndk_cards/intel/dk-dev-1sdx-p/readme.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
Minimal NDK Application Docs
</a>
<div class="version">
Git branch: devel, <br> Git hash: 83cc58d9
Git branch: devel, <br> Git hash: 27e3f5d0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion devel/ndk_cards/intel/dk-dev-agi027res/readme.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
Minimal NDK Application Docs
</a>
<div class="version">
Git branch: devel, <br> Git hash: 83cc58d9
Git branch: devel, <br> Git hash: 27e3f5d0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion devel/ndk_cards/reflexces/agi-fh400g/readme.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
Minimal NDK Application Docs
</a>
<div class="version">
Git branch: devel, <br> Git hash: 83cc58d9
Git branch: devel, <br> Git hash: 27e3f5d0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion devel/ndk_cards/silicom/fb2cghh/readme.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
Minimal NDK Application Docs
</a>
<div class="version">
Git branch: devel, <br> Git hash: 83cc58d9
Git branch: devel, <br> Git hash: 27e3f5d0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion devel/ndk_cards/silicom/fb4cgg3/readme.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
Minimal NDK Application Docs
</a>
<div class="version">
Git branch: devel, <br> Git hash: 83cc58d9
Git branch: devel, <br> Git hash: 27e3f5d0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion devel/ndk_cards/silicom/n6010/readme.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
Minimal NDK Application Docs
</a>
<div class="version">
Git branch: devel, <br> Git hash: 83cc58d9
Git branch: devel, <br> Git hash: 27e3f5d0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion devel/ndk_core/doc/configuration.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
Minimal NDK Application Docs
</a>
<div class="version">
Git branch: devel, <br> Git hash: 83cc58d9
Git branch: devel, <br> Git hash: 27e3f5d0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion devel/ndk_core/doc/devtree.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
Minimal NDK Application Docs
</a>
<div class="version">
Git branch: devel, <br> Git hash: 83cc58d9
Git branch: devel, <br> Git hash: 27e3f5d0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
Loading

0 comments on commit 2bdcdfc

Please sign in to comment.