Skip to content

Commit 9791342

Browse files
AWSaallurikristopk
authored andcommitted
document updates. (#434)
1 parent bc02590 commit 9791342

File tree

3 files changed

+25
-1
lines changed

3 files changed

+25
-1
lines changed

SDAccel/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ It is highly recommended you read the documentation and utilize software and har
3333
* SDAccel is a complete development environment for applications accelerated using Xilinx FPGAs
3434
* It leverages the OpenCL heterogeneous computing framework to offload compute intensive workloads to the FPGA
3535
* The accelerated application is written in C/C++, OpenCL or RTL with OpenCL APIs
36-
* 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.
36+
* 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.
3737

3838
<a name="prerequisites"></a>
3939
# Prerequisites

hdk/cl/examples/cl_dram_dma/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,8 @@ flr_reset is ignored in this design
141141
## Runtime software
142142
DMA accesses rely on the xdma driver- see the [xdma driver readme](../../../../sdk/linux_kernel_drivers/xdma/README.md)
143143

144+
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.
145+
144146
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)
145147

146148
There are two example tests in cl_dram_dma example.

sdk/linux_kernel_drivers/xdma/xdma_install.md

+22
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ XDMA is a Linux kernel driver for using DMA and/or User-defined interrupts for A
99
2. [Q: How do I get the source code of the `xdma` driver and compile it?](#howToCompile)
1010
3. [Q: How can I make sure the installed driver will be preserved following a kernel update?](#howToUpdateKernel)
1111
4. [Q: What PCIe Vendor-ID and Device-ID does XDMA driver support](#howToDIDnVID)
12+
5. [Q. Install of XDMA driver fails on AMI version 1.5.x or Later](#xdmainstallfail)
1213

1314
<a name="howIKnow"></a>
1415
**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-
175176
Be sure to remake and re-install the XDMA driver after modifying the device table.
176177

177178
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.
179+
180+
<a name="xdmainstallfail"></a>
181+
**Q: Install of XDMA driver fails on AMI version 1.5.x or Later**
182+
183+
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.
184+
185+
To check if XOCL driver is running
186+
187+
```
188+
lsmod | grep xocl
189+
190+
```
191+
To Remove XOCL driver
192+
193+
```
194+
sudo rmmod xocl
195+
196+
```
197+
198+
XDMA driver install can proceed once XOCL driver is removed.
199+

0 commit comments

Comments
 (0)