Merge pull request #49 from aws/kristopk-patch-3

Errata updates

Author: kristopk

ERRATA.md

@@ -43,6 +43,7 @@ Any items in this release marked as WIP (Work-in-progress) or NA (Not avaiable y
 
 * The integrated DMA function is in Beta stage.  Known issues: 
     * DMA READ addresses crossing 4K page boundaries.  The failure can be triggered by READ transfers that start on an address other than 4K aligned AND cross the 4K page boundary.  READ transfers that do not cross the 4K boundary OR transfers that start at the beginning of a 4K page and greater than 4K size are not susceptible to the error.  WRITE transfers are not affected by this issue Developers should use 4K aligned address boundaries on any READ transfer that can cross a 4K boundary to avoid the issue. 
-    * Integrated DMA with large transfer sizes (16KB or greater) can cause timeouts between the Shell and CL if the Shell can’t respond with all data before the timeout.  Transfer sizes of 8KB or less are supported with the integrated DMA engine for this revision of the Shell.  Shell-CL interface timeouts can be detected by checking metrics using this command:  `sudo fpga-describe-local-image -S 0 -M`
+    * Transfer sizes of 8KB or less are supported with the integrated DMA engine for this revision of the Shell.  Integrated DMA with large transfer sizes (16KB or greater) can cause timeouts between the Shell and CL if the Shell can’t respond with all data before the timeout.  Please see documentation on how to [detect a timeout has occured](./hdk/docs/HOWTO_detect_shell_timeout.md)
+
 
 

hdk/docs/HOWTO_detect_shell_timeout.md

@@ -0,0 +1,54 @@
+
+# How to detect a shell timeout has occured
+
+* Shell-CL interface timeouts can be detected by checking for non-zero timeout counters.  These metrics can be read using this command:  
+```
+$sudo fpga-describe-local-image -S 0 -M
+AFI          0       agfi-0f0e045f919413242  loaded            0        ok               0       0x04151701
+AFIDEVICE    0       0x1d0f      0xf000      0000:00:1d.0
+sdacl-slave-timeout=0
+virtual-jtag-slave-timeout=0
+ocl-slave-timeout=0
+bar1-slave-timeout=0
+dma-pcis-timeout=0
+pcim-range-error=0
+pcim-axi-protocol-error=0
+pcim-axi-protocol-4K-cross-error=0
+pcim-axi-protocol-bus-master-enable-error=0
+pcim-axi-protocol-request-size-error=0
+pcim-axi-protocol-write-incomplete-error=0
+pcim-axi-protocol-first-byte-enable-error=0
+pcim-axi-protocol-last-byte-enable-error=0
+pcim-axi-protocol-bready-error=0
+pcim-axi-protocol-rready-error=0
+pcim-axi-protocol-wchannel-error=0
+sdacl-slave-timeout-addr=0x0
+sdacl-slave-timeout-count=0
+virtual-jtag-slave-timeout-addr=0x0
+virtual-jtag-slave-timeout-count=0
+ocl-slave-timeout-addr=0x8001
+ocl-slave-timeout-count=0
+bar1-slave-timeout-addr=0x2001
+bar1-slave-timeout-count=0
+dma-pcis-timeout-addr=0x0
+dma-pcis-timeout-count=0
+pcim-range-error-addr=0x0
+pcim-range-error-count=0
+pcim-axi-protocol-error-addr=0x0
+pcim-axi-protocol-error-count=0
+pcim-write-count=0
+pcim-read-count=0
+DDR0
+   write-count=0
+   read-count=0
+DDR1
+   write-count=0
+   read-count=0
+DDR2
+   write-count=29797854199
+   read-count=4
+DDR3
+   write-count=0
+   read-count=0
+```
+* For detailed infomation on metrics, see [Amazon FPGA Image Management Tools README](../../sdk//userspace/fpga_mgmt_tools/README.md)