Skip to content

Commit

Permalink
docs: Add Corundum IP Core (#1420)
Browse files Browse the repository at this point in the history
Signed-off-by: Jorge Marques <jorge.marques@analog.com>
  • Loading branch information
gastmaier authored Aug 21, 2024
1 parent df8e022 commit 46cdf4b
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 0 deletions.
70 changes: 70 additions & 0 deletions docs/library/corundum/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
.. _corundum:

Corundum
================================================================================

.. hdl-component-diagram::

The :git-hdl:`Corundum <library/corundum>` IP core
repackages `Corundum NIC <https://github.com/corundum/corundum>`__ as an IP Core.

Features
--------------------------------------------------------------------------------

* AXI-based configuration
* Vivado compatible

Files
--------------------------------------------------------------------------------

.. list-table::
:header-rows: 1

* - Name
- Description
* - :git-hdl:`library/corundum/corundum.v`
- Verilog source for the Corundum top module.
* - :git-hdl:`library/corundum/corundum_ip.tcl`
- TCL script to generate the Vivado IP-integrator project.

Configuration Parameters
--------------------------------------------------------------------------------

.. hdl-parameters::

Interface
--------------------------------------------------------------------------------

.. hdl-interfaces::

Building
--------------------------------------------------------------------------------

This project uses `Corundum NIC <https://github.com/corundum/corundum>`_
and it needs to be cloned alongside this repository.

.. code::
hdl/../> git clone https://github.com/corundum/corundum.git
hdl/../corundum/> git checkout ed4a26e2cbc0a429c45d5cd5ddf1177f86838914
hdl/library/corundum> make &
.. admonition:: Publications

The following papers pertain to the Corundum source code:

- J- A. Forencich, A. C. Snoeren, G. Porter, G. Papen, Corundum: An Open-Source 100-Gbps NIC, in FCCM'20.
(`FCCM Paper`_, `FCCM Presentation`_)
- J- A. Forencich, System-Level Considerations for Optical Switching in Data Center Networks. (`Thesis`_)

.. _FCCM Paper: https://www.cse.ucsd.edu/~snoeren/papers/corundum-fccm20.pdf
.. _FCCM Presentation: https://www.fccm.org/past/2020/forums/topic/corundum-an-open-source-100-gbps-nic/
.. _Thesis: https://escholarship.org/uc/item/3mc9070t

References
--------------------------------------------------------------------------------

* :adi:`AD-GMSL2ETH-SL`
* :ref:`ad_gmsl2eth_sl`
* :git-hdl:`projects/ad_gmsl2eth_sl`
* :git-hdl:`library/corundum`
1 change: 1 addition & 0 deletions docs/library/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ Utilities
axi_sysid/index
axi_tdd/index
common/ad_dds/index
corundum/index
util_axis_fifo/index
util_axis_fifo_asym/index
util_extract/index
Expand Down

0 comments on commit 46cdf4b

Please sign in to comment.