Updates for first release 1.0.0. master release-1.0.0
authorTerry Barnaby <terry.barnaby@beam.beam.ltd.uk>
Tue, 16 Jun 2020 10:32:19 +0000 (11:32 +0100)
committerTerry Barnaby <terry.barnaby@beam.beam.ltd.uk>
Tue, 16 Jun 2020 10:32:19 +0000 (11:32 +0100)
12 files changed:
Makefile
Readme.txt [new file with mode: 0644]
doc/Readme.pdf
docsrc/DuneNvme-releasenotes.html
docsrc/DuneNvmeStorageDesign.odt
docsrc/DuneNvmeStorageManual.odt
docsrc/DuneNvmeStorageTestSoftware.odt
docsrc/fpga_doxygen.dox
docsrc/fpga_overview.dox
docsrc/host_doxygen.dox
docsrc/host_overview.dox
src/NvmeStorageUnit.vhd

index 3f31126c3234f9a2a18474797cbcabca578fb64c..4dfa08ec57e2c394fef5a47bc0be8d20026fe7d5 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -17,8 +17,8 @@ all:
        make -C test/bfpga_driver
 
 all_targets:
-       make -C vivado DuneNvmeTest
-       make -C vivado DuneNvmeTestOspero
+       make -C vivado PROJECT=DuneNvmeTest
+       make -C vivado PROJECT=DuneNvmeTestOpsero
        make -C test
        make -C test/bfpga_driver
 
@@ -39,7 +39,7 @@ distclean: clean
 release:
        rm -fr /tmp/${PROJECT}-${VERSION}
        mkdir -p /tmp/${PROJECT}-${VERSION} /tmp/${PROJECT}-${VERSION}/vivado
-       rsync -a --delete --exclude=*.[od] Config.mk license.txt Makefile sim src tools test /tmp/${PROJECT}-${VERSION}
+       rsync -a --delete --exclude=*.[od] Config.mk Readme.txt license.txt Makefile sim src tools test doc /tmp/${PROJECT}-${VERSION}
        rsync -a --delete --exclude=*.[od] vivado/Makefile vivado/Config.mk vivado/Config-template.mk vivado/Vivado.mk vivado/*.xpr vivado/bitfiles /tmp/${PROJECT}-${VERSION}/vivado
        tar -czf ../../releases/${PROJECT}-${VERSION}.tar.gz -C /tmp ${PROJECT}-${VERSION}
 
diff --git a/Readme.txt b/Readme.txt
new file mode 100644 (file)
index 0000000..0ea19a2
--- /dev/null
@@ -0,0 +1,10 @@
+Dune NVMe Storage System
+===========================
+
+This directory contains the source code for the Dune NvmeStorage system together with a simple
+NVMe test environment that allows experimentation with the low level PCIe NVMe interfaces as
+available on a Xilinx FPGA environment.
+The directory contains the FPGA VHDL source code, simulation environment and build environment 
+or the Nvme test FPGA firmware as well as the nvme_test host software.
+
+Please see the documentation in the doc directory.
index 3e99ed6ed7f4fcad1f38c02a2f105b15563d7a7d..1082891cd3d4b5cbc93851a40734bdc11628da47 100644 (file)
Binary files a/doc/Readme.pdf and b/doc/Readme.pdf differ
index 9af37b06d23164c7a2a489e1bd40ecb2de14aac9..51a0a26157a5ebb40531e2eb2ff288989615ecff 100644 (file)
@@ -3,13 +3,93 @@
 <head>
        <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
        <title>DuneNvme test system Release Notes</title>
+       <meta name="generator" content="LibreOffice 6.3.6.2 (Linux)"/>
+       <meta name="created" content="00:00:00"/>
+       <meta name="changedby" content="Terry Barnaby"/>
+       <meta name="changed" content="2020-06-16T11:18:09.571516965"/>
+       <style type="text/css">
+               h3.cjk { font-family: "Noto Sans CJK SC" }
+               h3.ctl { font-family: "Lohit Devanagari" }
+               pre.cjk { font-family: "Noto Sans Mono CJK SC", monospace }
+       </style>
 </head>
-<body>
-<h1 align="center">DuneNvme test system Release Notes</h1>
-
-<h3 class="western">Release 1.0.0: Preliminary</h3>
+<body lang="en-GB" dir="ltr"><h1 align="center">DuneNvme test system
+Release Notes</h1>
+<h3 class="western">Release 1.0.0: <font face="Liberation Serif, serif"><font size="4" style="font-size: 14pt"><b>2020-06-16</b></font></font></h3>
 <ul>
-       <li>First release.</li>
+       <li><p>First release of Dune NvmeStorage system. This includes
+       builds for the AB17-M2FMC and Opsero OP47 NVMe boards.</p>
 </ul>
+<p>NvmeStorage Utilisation:</p>
+<table width="580" cellpadding="0" cellspacing="0" style="page-break-inside: avoid">
+       <col width="78"/>
+
+       <col width="79"/>
+
+       <col width="75"/>
+
+       <col width="37"/>
+
+       <col width="40"/>
+
+       <col width="64"/>
+
+       <col width="64"/>
+
+       <col width="49"/>
+
+       <col width="95"/>
+
+       <tr valign="top">
+               <th width="78" style="border: none; padding: 0cm"><p>Total LUTs</p>
+               </th>
+               <th width="79" style="border: none; padding: 0cm"><p>Logic LUTs</p>
+               </th>
+               <th width="75" style="border: none; padding: 0cm"><p>LUTRAMs</p>
+               </th>
+               <th width="37" style="border: none; padding: 0cm"><p>SRLs</p>
+               </th>
+               <th width="40" style="border: none; padding: 0cm"><p>FFs</p>
+               </th>
+               <th width="64" style="border: none; padding: 0cm"><p>RAMB36</p>
+               </th>
+               <th width="64" style="border: none; padding: 0cm"><p>RAMB18</p>
+               </th>
+               <th width="49" style="border: none; padding: 0cm"><p>URAM</p>
+               </th>
+               <th width="95" style="border: none; padding: 0cm"><p>DSP48 Blocks</p>
+               </th>
+       </tr>
+       <tr valign="top">
+               <td width="78" style="border: none; padding: 0cm" sdval="10625" sdnum="2057;"><p>
+                       10625</p>
+               </td>
+               <td width="79" style="border: none; padding: 0cm" sdval="8729" sdnum="2057;"><p>
+                       8729</p>
+               </td>
+               <td width="75" style="border: none; padding: 0cm" sdval="1888" sdnum="2057;"><p>
+                       1888</p>
+               </td>
+               <td width="37" style="border: none; padding: 0cm" sdval="8" sdnum="2057;"><p>
+                       8</p>
+               </td>
+               <td width="40" style="border: none; padding: 0cm" sdval="13773" sdnum="2057;"><p>
+                       13773</p>
+               </td>
+               <td width="64" style="border: none; padding: 0cm" sdval="24" sdnum="2057;"><p>
+                       24</p>
+               </td>
+               <td width="64" style="border: none; padding: 0cm" sdval="26" sdnum="2057;"><p>
+                       26</p>
+               </td>
+               <td width="49" style="border: none; padding: 0cm" sdval="0" sdnum="2057;"><p>
+                       0</p>
+               </td>
+               <td width="95" style="border: none; padding: 0cm" sdval="0" sdnum="2057;"><p>
+                       0</p>
+               </td>
+       </tr>
+</table>
+<pre class="western"></pre>
 </body>
-</html>
+</html>
\ No newline at end of file
index 9d42c03c5d7482fe6d83551c93bf6d2b9285e5fa..f0e369abd00217191e0d95aeaf90cd81aa3c4025 100644 (file)
Binary files a/docsrc/DuneNvmeStorageDesign.odt and b/docsrc/DuneNvmeStorageDesign.odt differ
index b34cbe6789b236f5dada0339123891d4b0d62347..3e2a97cdccffdb8f0e98451e5bb279d22ac0fd2c 100644 (file)
Binary files a/docsrc/DuneNvmeStorageManual.odt and b/docsrc/DuneNvmeStorageManual.odt differ
index c343f14ddd78fe06653fdabce4b68a6068687100..2ed7c037bfc901d97e2ceac91518d9327622254d 100644 (file)
Binary files a/docsrc/DuneNvmeStorageTestSoftware.odt and b/docsrc/DuneNvmeStorageTestSoftware.odt differ
index 2772efe893c88ba12f883850bb82b2fe41a9e543..37859b0c339099091e72d8705b86f5a012c65ff1 100644 (file)
@@ -1,7 +1,7 @@
 # Doxyfile 1.8.15
 
 PROJECT_NAME           = "DuneNvme"
-PROJECT_NUMBER         = 0.4.1
+PROJECT_NUMBER         = 1.0.0
 PROJECT_BRIEF          = "This is a simple NVMe test environment that allows experimentation with the low level PCIe NVMe interfaces as available on a Xilinx FPGA environment."
 PROJECT_LOGO           =
 INPUT                  = fpga_overview.dox ../src
index fea74ad8730c7bf5da02426f81cd7fcb9ff7c211..c5bb47c5521da823a0870adc1e25d42249ae1ccc 100644 (file)
@@ -5,7 +5,7 @@
 /**
 \author Dr Terry Barnaby
 \version 1.0.0
-\date 2020-05-30
+\date 2020-06-16
 
 \mainpage
 
index 5c1f0bedb27c89b8342fc78f2484ab2e6e449fa2..3bf9a8c13ac959ae7b10bd8cf6dea9db09180d1d 100644 (file)
@@ -1,7 +1,7 @@
 # Doxyfile 1.8.15
 
 PROJECT_NAME           = "DuneNvme"
-PROJECT_NUMBER         = 0.4.1
+PROJECT_NUMBER         = 1.0.0
 PROJECT_BRIEF          = "This is a simple NVMe test environment that allows experimentation with the low level PCIe NVMe interfaces as available on a Xilinx FPGA environment."
 PROJECT_LOGO           =
 INPUT                  = host_overview.dox ../test
index 9f073dd53b332677d7c862de1523247987b6359e..28116b5762966f9a0ff180e2f1cf05356fb325b7 100644 (file)
@@ -5,7 +5,7 @@
 /**
 \author Dr Terry Barnaby
 \version 1.0.0
-\date 2020-05-30
+\date 2020-06-16
 
 \mainpage
 
index dfcf2b5e7d6733a65b391b991f9e816cd80b18d5..089d64e212a93f410a91c424c708c5f37d225fe9 100644 (file)
@@ -844,6 +844,7 @@ begin
                dataIn          => dataIn1,
 
                waitingForData  => waitingForData,
+               complete        => writeComplete,
                
                requestOut      => writeSend,
                replyIn         => writeRecv,