Documentation updates.
authorTerry Barnaby <terry.barnaby@beam.beam.ltd.uk>
Fri, 5 Jun 2020 12:25:32 +0000 (13:25 +0100)
committerTerry Barnaby <terry.barnaby@beam.beam.ltd.uk>
Fri, 5 Jun 2020 12:25:32 +0000 (13:25 +0100)
docsrc/DuneNvmeStorageManual.odt
docsrc/DuneNvmeStorageTestSoftware.odt [new file with mode: 0644]
docsrc/Makefile
test/bfpga_driver/bfpga.c
test/test_nvme.cpp

index 51d84ee49182ea45b3acacec4a39f8faaaeb7304..470d49e0a0685173a58e35da4143004616efe700 100644 (file)
Binary files a/docsrc/DuneNvmeStorageManual.odt and b/docsrc/DuneNvmeStorageManual.odt differ
diff --git a/docsrc/DuneNvmeStorageTestSoftware.odt b/docsrc/DuneNvmeStorageTestSoftware.odt
new file mode 100644 (file)
index 0000000..134bed6
Binary files /dev/null and b/docsrc/DuneNvmeStorageTestSoftware.odt differ
index 21adffb68122f4b3d37645aa572c6e38a2c6b95a..f55d0998e168fd8db373ff93f22b32a083cc8d88 100644 (file)
@@ -45,6 +45,7 @@ docs:
        soffice --headless --convert-to pdf --outdir ../doc DuneNvmeStorageManual.odt
        soffice --headless --convert-to pdf --outdir ../doc DuneNvmeStorageDesign.odt
        soffice --headless --convert-to pdf --outdir ../doc DuneNvmeStorageProject.odt
+       soffice --headless --convert-to pdf --outdir ../doc DuneNvmeStorageTestSoftware.odt
 
 docspdf: docs
        (cd ../doc/host/latex; make)
index 5e884859863df2267220e665eb3f02eef27d54bd..bee990505329e643a5b0aaf840e4b99393af4193 100644 (file)
  * The Xilinx XDMA IP provides up to 8 AXI4 streams on the FPGA.
  * The driver creates a physically contiguous memory region for each DMA channel of a
  * fixed size. This simplifies the DMA as multiple scatter/gather regions are not needed.
- * For simplicty data is coped from/to the applications user space memort from these regions
+ * For simplicity data is coped from/to the applications user space memory from these regions
  * by the driver. It would be possible to map these regions into the applications memory if
  * wanted for greater performance.
  * The Xilinx XDMA PCIe IP core manual, PG195, should be looked at for information on
  * the hardware interface that this driver uses.
  *
  * As stated it is simple, lots of improvements could be had, but it is relatively
- * easy to use and to debug bcuase of its simplicity.
+ * easy to use and to debug because of its simplicity.
  *
  * There is some problem with interrupt status reporting. Not sure if this is the test FPGA hardware
- * design or someing in this driver. It appears that the end of dma status interrupt is lost occassionaly.
- * Here we force a retest of status in the wait loops if a timeout occures.
+ * design or something in this driver. It appears that the end of DMA status interrupt is lost occasionally.
+ * Here we force a retest of status in the wait loops if a timeout occurs.
  *
  * Copyright (c) 2020 BEAM Ltd. All rights reserved.
  *
index 3947c6be684ea1331f7ff650de9ea81e6d9fd22a..7badfe294bd3cefa43762f24a37afc2da3acd8c0 100644 (file)
@@ -612,7 +612,7 @@ int Control::nvmeCaptureAndRead(){
        te = getTime();
        
        uprintf("Read time: %f\n", te - ts);
-       r = ((double(BlockSize) * onumBlocks) / (te - ts));
+       r = ((double(BlockSize) * oreadNumBlocks) / (te - ts));
        printf("NvmeRead: rate: %f MBytes/s\n", r / (1024 * 1024));
        
        return 0;
@@ -1154,7 +1154,7 @@ int main(int argc, char** argv){
        
        if(listTests){
                printf("capture: Perform data input from FPGA TestData source into Nvme's.\n");
-               printf("read: Read data from Vvme's\n");
+               printf("read: Read data from Nvme's\n");
                printf("captureAndRead: Perform data input from FPGA TestData source into Nvme's and read data.\n");
                printf("write: Write data to Nvme's\n");
                printf("trim: Trim/deallocate blocks on Nvme's\n");