document updates. (aws#434)

wjblanke · Oct 5, 2018 · 9791342 · 9791342
1 parent bc02590
commit 9791342
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 1 deletion.
diff --git a/SDAccel/README.md b/SDAccel/README.md
@@ -33,7 +33,7 @@ It is highly recommended you read the documentation and utilize software and har
 * SDAccel is a complete development environment for applications accelerated using Xilinx FPGAs
 * It leverages the OpenCL heterogeneous computing framework to offload compute intensive workloads to the FPGA
 * The accelerated application is written in  C/C++, OpenCL or RTL with OpenCL APIs
-* Once you complete this quick starting exampl, see the [SDAccel GUI Guide](./docs/README_GUI.md) to access the fully integrated Eclipse-based environment with built-in debug, profiling and performance analysis tools. 
+* Once you complete this quick starting example, see the [SDAccel GUI Guide](./docs/README_GUI.md) to access the fully integrated Eclipse-based environment with built-in debug, profiling and performance analysis tools. 
 
 <a name="prerequisites"></a>
 # Prerequisites

diff --git a/hdk/cl/examples/cl_dram_dma/README.md b/hdk/cl/examples/cl_dram_dma/README.md
@@ -141,6 +141,8 @@ flr_reset is ignored in this design
 ## Runtime software
 DMA accesses rely on the xdma driver- see the [xdma driver readme](../../../../sdk/linux_kernel_drivers/xdma/README.md)
 
+Developers using AMI 1.5.0 or Later Instances that come with pre-installed Xilinx Runtime Environment (XRT) should [refer to this note](sdk/linux_kernel_drivers/xdma/xdma_install.md#xdmainstallfail) before installing XDMA driver.
+
 The DRAM DMA example includes runtime software to demonstate working DMA accesses. The runtime example is located [in the runtime directory](software/runtime/test_dram_dma.c)
 
 There are two example tests in cl_dram_dma example.

diff --git a/sdk/linux_kernel_drivers/xdma/xdma_install.md b/sdk/linux_kernel_drivers/xdma/xdma_install.md
@@ -9,6 +9,7 @@ XDMA is a Linux kernel driver for using DMA and/or User-defined interrupts for A
 2. [Q: How do I get the source code of the `xdma` driver and compile it?](#howToCompile)
 3. [Q: How can I make sure the installed driver will be preserved following a kernel update?](#howToUpdateKernel) 
 4. [Q: What PCIe Vendor-ID and Device-ID does XDMA driver support](#howToDIDnVID)
+5. [Q. Install of XDMA driver fails on AMI version 1.5.x or Later](#xdmainstallfail)
 
 <a name="howIKnow"></a>
 **Q: How do I know if the XDMA driver is available and installed?** 
@@ -175,3 +176,24 @@ where 0x1d0f is the vendor ID for Amazon and 0xf001 is the device ID for the cl-
 Be sure to remake and re-install the XDMA driver after modifying the device table.
 
 Amazon encourages pull requests to this github to add CL ID's to the driver, so there is no need to fork the driver or SDK.
+
+<a name="xdmainstallfail"></a>
+**Q: Install of XDMA driver fails on AMI version 1.5.x or Later**
+
+DEVAMI 1.5.0 or Later instances come with preinstalled Xilinx Runtime Environment (XRT). XOCL driver come pre-installed with XRT. This prevents XDMA driver install. Please remove XOCL driver module and then proceed to install XDMA driver.
+
+ To check if XOCL driver is running
+
+ ```
+ lsmod | grep xocl
+ 
+ ```
+ To Remove XOCL driver
+
+ ```
+ sudo rmmod xocl
+ 
+ ```
+
+ XDMA driver install can proceed once XOCL driver is removed.
+