Skip to content

Commit 05e5ea6

Browse files
committed
Updated AWS tutorials
1 parent cee5071 commit 05e5ea6

File tree

10 files changed

+83
-100
lines changed

10 files changed

+83
-100
lines changed

docs/aws-getting-started/CPP/README.md

+3-6
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,9 @@ This optional module will show you how to:
6464
You will need the following:
6565
- A Xilinx account — create one [here](https://www.xilinx.com/registration/create-account.html)
6666
- A Linux computer running either:
67-
- Red Hat Enterprise Workstation/Server 7.3-7.4 (64-bit)
68-
- CentOS 7.2
69-
- CentOS 7.3-7.4 (64-bit)
70-
- Ubuntu Linux 16.04.3 LTS (64-bit)
71-
- Linux kernel 4.4.0 is supported
72-
- Ubuntu LTS enablement (also called HWE or Hardware Enablement) is _not_ supported
67+
- Ubuntu 16.04.5 LTS, 18.04.1 LTS
68+
- CentOS 7.4, 7.5, 7.6
69+
- RHEL 7.4, 7.5, 7.6
7370

7471
[**FOLLOW THE INSTRUCTIONS**](STEP5.md)
7572
<br>

docs/aws-getting-started/CPP/STEP1.md

+11-6
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,11 @@ source <(curl -s https://s3.amazonaws.com/aws-fpga-developer-ami/1.5.0/Scripts/s
9595
The script takes about 10 minutes to run and finishes by setting a password for the 'centos' user.
9696

9797
**IMPORTANT**: Take note of the password generated by the script. You will need it to connect using RDP.
98+
9899
2. Return to the **AWS EC2 dashboard** in your web browser.
100+
99101
3. Select your instance, then from the **Actions** menu, select **Instance State** and then select **Reboot**.
102+
100103
4. Wait a couple of minutes for the instance to complete the reboot cycle.
101104

102105
After you have completed this step, you are ready to connect to the instance using a remote desktop client.
@@ -114,7 +117,7 @@ After you have completed this step, you are ready to connect to the instance usi
114117
* Click **Yes** to dismiss the message. The Remote Desktop Connection window opens with a login prompt.
115118
* Log in with the following credentials:
116119
- User: **centos**
117-
- Password: *password generated by the `set_gui.sh` script*
120+
- Password: *password generated by the `setup_gui.sh` script*
118121
* Click **Ok**.
119122

120123
You are now connected to the instance running Centos 7 and the FPGA Developer AMI.
@@ -150,7 +153,7 @@ In this step, you install the necessary files to build and execute applications
150153

151154
## 4. Running the SDAccel 'Hello World' Example on AWS F1
152155

153-
This final section explains how run the SDAccel `helloworld_ocl` example on AWS F1 and confirm that the environment is properly configured.
156+
This final section explains how run the SDAccel `helloworld_c` example on AWS F1 and confirm that the environment is properly configured.
154157

155158
#### Step 1: Set Up the SDAccel Environment
156159

@@ -167,14 +170,14 @@ The SDAccel emulation flows allows testing, profiling, and debugging the applica
167170

168171
1. Run the SW Emulation flow for the SDAccel 'hello world' example:
169172
```bash
170-
cd $SDACCEL_DIR/examples/xilinx/getting_started/host/helloworld_ocl/
173+
cd $SDACCEL_DIR/examples/xilinx/getting_started/host/helloworld_c/
171174
make clean
172175
make check TARGETS=sw_emu DEVICES=$AWS_PLATFORM all
173176
```
174177

175178
2. Run the HW Emulation flow for the SDAccel 'hello world' example:
176179
```bash
177-
cd $SDACCEL_DIR/examples/xilinx/getting_started/host/helloworld_ocl/
180+
cd $SDACCEL_DIR/examples/xilinx/getting_started/host/helloworld_c/
178181
make clean
179182
make check TARGETS=hw_emu DEVICES=$AWS_PLATFORM all
180183
```
@@ -190,7 +193,7 @@ Building these files is a two-step process. First SDAccel is used to build the h
190193

191194
1. Build the host application and the &ast;.xclbin (Xilinx FPGA binary file):
192195
```bash
193-
cd $SDACCEL_DIR/examples/xilinx/getting_started/host/helloworld_ocl/
196+
cd $SDACCEL_DIR/examples/xilinx/getting_started/host/helloworld_c/
194197
make clean
195198
make TARGETS=hw DEVICES=$AWS_PLATFORM all
196199
```
@@ -237,9 +240,11 @@ aws ec2 describe-fpga-images --fpga-image-ids <AFI ID>
237240

238241
#### Step 5: Execute the Host Application
239242

243+
:warning: **IMPORTANT** : The previous steps do not require an AWS EC2 F1 instance. They can be executed on other AWS EC2 instances such as C4 or C5. However, the steps that follow must be performed on an AWS EC2 F1 instance. You will receive error messages if you do not perform the following steps on an F1 instance.
244+
240245
1. Execute the following commands in the instance terminal:
241246
```bash
242-
cd $SDACCEL_DIR/examples/xilinx/getting_started/host/helloworld_ocl/
247+
cd $SDACCEL_DIR/examples/xilinx/getting_started/host/helloworld_c/
243248
sudo sh
244249
source /opt/xilinx/xrt/setup.sh
245250
./helloworld

docs/aws-getting-started/CPP/STEP3.md

-3
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,6 @@ The following videos present key concepts needed to successfully run existing C/
1111
### 3. Fundamental Concepts of Application Host Code
1212
[**WATCH VIDEO**](https://www.xilinx.com/video/hardware/concepts-of-application-host-code.html)
1313

14-
### 4. OpenCL Memory Architecture
15-
[**WATCH VIDEO**](https://www.xilinx.com/video/hardware/opencl-memory-architecture.html)
16-
1714
<hr/>
1815
<p align="center"><b>
1916
<a href="STEP4.md">NEXT: Practice and Experiment with C/C++ Kernels</a>

docs/aws-getting-started/CPP/STEP4.md

+18-14
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,38 @@
1-
# Practice and Experiment with C/OpenCL Kernels
1+
# Practice and Experiment with C/C++ and OpenCL Kernels
22

33
Apply and practice what you've learned in the earlier steps of this guide by running more hands-on examples. Familiarize yourself with online resources relating to the SDAccel™ environment, and make your way to the [AWS forum](https://forums.aws.amazon.com/forum.jspa?forumID=243) to search for knowledge and find answers.
44

5+
## Run the On-demand SDAccel AWS F1 Developer Labs
6+
7+
By going through these labs you will learn how to develop accelerated applications using the Xilinx SDAccel development environment.
8+
9+
[**START THE LABS**](https://github.com/Xilinx/SDAccel-AWS-F1-Developer-Labs)
10+
11+
<br>
12+
513
## Experiment with Other Examples
614

715
Running and experimenting with these three examples of the C/OpenCL™ kernels allows you to further familiarize yourself with good coding practices and kernel optimization techniques.
816

917
### Loop Pipelining
1018
This example demonstrates how loop pipelining can be used to improve the performance of a kernel.
1119

12-
Download and run [this example](https://github.com/Xilinx/SDAccel_Examples/tree/2018.2/getting_started/kernel_opt/loop_pipeline_ocl) from the SDAccel GitHub repository.
20+
Download and run [this example](https://github.com/Xilinx/SDAccel_Examples/tree/master/getting_started/kernel_opt/loop_pipeline_c) from the SDAccel GitHub repository.
1321

1422
### Reordering Loops
1523
This example demonstrates how loop reordering can be used to improve the performance of a kernel.
1624

17-
Download and run [this example](https://github.com/Xilinx/SDAccel_Examples/tree/2018.2/getting_started/kernel_opt/loop_reorder_c) from the SDAccel GitHub repository.
25+
Download and run [this example](https://github.com/Xilinx/SDAccel_Examples/tree/master/getting_started/kernel_opt/loop_reorder_c) from the SDAccel GitHub repository.
1826

1927
### Loop Fusion
2028
This example demonstrates how to fuse two loops into one to improve the performance of an OpenCL kernel.
2129

22-
Download and run [this example](https://github.com/Xilinx/SDAccel_Examples/tree/2018.2/getting_started/kernel_opt/loop_fusion_c) from the SDAccel GitHub repository.
30+
Download and run [this example](https://github.com/Xilinx/SDAccel_Examples/tree/master/getting_started/kernel_opt/loop_fusion_c) from the SDAccel GitHub repository.
2331

2432
### Additional Examples
2533
The Xilinx Github repository contains more than 80 examples to help you learn. Browse the repository to find more examples of interest, starting with more coding and optimization examples.
2634

27-
Browse other [OpenCL kernel coding and optimization examples](https://github.com/Xilinx/SDAccel_Examples/tree/2018.2/getting_started/kernel_opt).
35+
Browse other [C/C++ and OpenCL kernel coding and optimization examples](https://github.com/Xilinx/SDAccel_Examples/tree/master/getting_started/kernel_opt).
2836

2937
<br>
3038

@@ -34,16 +42,12 @@ The [AWS F1 SDAccel Development forum](https://forums.aws.amazon.com/forum.jspa?
3442
<br>
3543

3644
## Learn More about the SDAccel Environment
37-
#### SDAccel QuickTake Video Tutorials
38-
[Fundamental Concepts of Application Host Code](https://www.xilinx.com/video/hardware/concepts-of-application-host-code.html)
39-
4045

41-
#### Documentation for SDAccel v2018.3
42-
* _SDx Development Environment Release Notes, Installation, and Licensing Guide_ ([UG1238](https://www.xilinx.com/cgi-bin/docs/rdoc?v=replace;d=ug1238-sdx-rnil.pdf))
43-
* _SDAccel Programmers Guide_ ([UG1277](https://www.xilinx.com/cgi-bin/docs/rdoc?v=replace;d=ug1277-sdaccel-programmers-guide.pdf))
44-
* _SDAccel Environment User Guide_ ([UG1023](https://www.xilinx.com/cgi-bin/docs/rdoc?v=replace;d=ug1023-sdaccel-user-guide.pdf))
45-
* _SDAccel Environment Optimization Guide_ ([UG1207](https://www.xilinx.com/cgi-bin/docs/rdoc?v=replace;d=ug1207-sdaccel-optimization-guide.pdf))
46-
* _SDAccel Environment Tutorial_ ([UG1021](https://www.xilinx.com/cgi-bin/docs/rdoc?v=replace;d=ug1021-sdaccel-intro-tutorial.pdf))
46+
#### Documentation for SDAccel v2019.1
47+
* _SDx Development Environment Release Notes, Installation, and Licensing Guide_ ([UG1238](https://www.xilinx.com/html_docs/xilinx2019_1/sdaccel_doc/gsv1547661552998.html#gsv1547661552998))
48+
* _SDAccel Programmers Guide_ ([UG127](https://www.xilinx.com/html_docs/xilinx2019_1/sdaccel_doc/vno1533881025717.html))
49+
* _SDAccel Environment User Guide_ ([UG1023](https://www.xilinx.com/html_docs/xilinx2019_1/sdaccel_doc/itd1534452174535.html))
50+
* _SDAccel Environment Optimization Guide_ ([UG1207](https://www.xilinx.com/html_docs/xilinx2019_1/sdaccel_doc/itd1534452174535.html))
4751

4852
<hr/>
4953
<p align="center"><b>

docs/aws-getting-started/CPP/STEP5.md

+11-18
Original file line numberDiff line numberDiff line change
@@ -16,33 +16,26 @@ Before going through the steps described in this document, you should complete t
1616

1717
## Requirements
1818
The supported operating systems for SDaccel on-premise development are:
19-
- Red Hat Enterprise Workstation/Server 7.3-7.4 (64-bit)
20-
- CentOS 7.2
21-
- CentOS 7.3-7.4 (64-bit)
22-
- Ubuntu Linux 16.04.3 LTS (64-bit)
23-
- Linux kernel 4.4.0 is supported
24-
- Ubuntu LTS enablement (also called HWE or Hardware Enablement) is _not_ supported
19+
- Ubuntu 16.04.5 LTS, 18.04.1 LTS
20+
- CentOS 7.4, 7.5, 7.6
21+
- RHEL 7.4, 7.5, 7.6
22+
23+
Visit [this page](https://www.xilinx.com/html_docs/xilinx2019_1/sdaccel_doc/igz1531201833632.html#olw1504034315783) for a complete description of other system requirements.
2524

2625
# 1. Installing and licensing SDAccel in your own environment
2726

2827
## Downloading the SDAccel Development Environment
29-
In order to develop any SDAccel application on-premise, you must install the same version of SDAccel as deployed on AWS F1.
30-
The SDAccel installer can be found here:
3128

32-
* Xilinx Vivado v2018.2 or v2018.2.op (64-bit)
33-
* License: EF-VIVADO-SDX-VU9P-OP
34-
* SW Build 2258646 on Thu Jun 14 20:02:38 MDT 2018
35-
* IP Build 2256618 on Thu Jun 14 22:10:49 MDT 2018
36-
* URL: [https://www.xilinx.com/member/forms/download/xef.html?filename=Xilinx_SDx_op_Lin_2018.2_0614_1954_Lin64.bin&akdm=0](https://www.xilinx.com/member/forms/download/xef.html?filename=Xilinx_SDx_op_Lin_2018.2_0614_1954_Lin64.bin&akdm=0)
37-
* MD5 SUM Value: 6b6939e70d4fa90677d2c54a37ec25c7
29+
In order to develop any SDAccel application on-premise, you must install the same version of SDAccel as deployed on AWS F1. Refer to this page for tool version and download instructions: [enabling development on premises](https://github.com/aws/aws-fpga/edit/master/hdk/docs/on_premise_licensing_help.md)
30+
3831

3932
## Requesting a License
4033

4134
If you are a new user, you will also need to obtain an on-premise license of Vivado®. You can request both _node-locked_ and _floating licenses_ [here](https://www.xilinx.com/products/design-tools/acceleration-zone/ef-vivado-sdx-vu9p-op-fl-nl.html) (links are on the right side of the page).
4235

4336
## Installing SDAccel
4437

45-
* To install the tool, refer to the instructions in the _SDAccel Environment Release Notes, Installation, and Licensing Guide_ [(UG1238)](https://www.xilinx.com/support/documentation/sw_manuals/xilinx2018_3/ug1238-sdx-rnil.pdf).
38+
* To install the tool, refer to the instructions in the _SDAccel Environment Release Notes, Installation, and Licensing Guide_ [(UG1238)](https://www.xilinx.com/html_docs/xilinx2019_1/sdaccel_doc/yrc1534452173645.html).
4639

4740
## Cloning the AWS-FPGA Git Repository
4841

@@ -77,7 +70,7 @@ After you confirm that the GUI has opened successfully, close the GUI.
7770
Execute the following commands to run the SW Emulation step for the SDAccel `helloworld` example:
7871

7972
```bash
80-
cd $HOME/aws-fpga/SDAccel/examples/xilinx_2018.2/getting_started/host/helloworld_c/
73+
cd $HOME/aws-fpga/SDAccel/examples/xilinx_2019.1/getting_started/host/helloworld_c/
8174
make clean
8275
make check TARGETS=sw_emu DEVICES=$AWS_PLATFORM all
8376
```
@@ -87,7 +80,7 @@ make check TARGETS=sw_emu DEVICES=$AWS_PLATFORM all
8780
Execute the following commands to run the HW Emulation step for the SDAccel `helloworld` example:
8881

8982
```bash
90-
cd $HOME/aws-fpga/SDAccel/examples/xilinx_2018.2/getting_started/host/helloworld_c/
83+
cd $HOME/aws-fpga/SDAccel/examples/xilinx_2019.1/getting_started/host/helloworld_c/
9184
make clean
9285
make check TARGETS=hw_emu DEVICES=$AWS_PLATFORM all
9386
```
@@ -97,7 +90,7 @@ make check TARGETS=hw_emu DEVICES=$AWS_PLATFORM all
9790
* Execute the following commands to build the FPGA binary for the SDAccel `helloworld` example:
9891

9992
```bash
100-
cd $HOME/aws-fpga/SDAccel/examples/xilinx_2018.2/getting_started/host/helloworld_c/
93+
cd $HOME/aws-fpga/SDAccel/examples/xilinx_2019.1/getting_started/host/helloworld_c/
10194
make clean
10295
make TARGETS=hw DEVICES=$AWS_PLATFORM all
10396
```

docs/aws-getting-started/RTL/README.md

+3-6
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,9 @@ This optional module will show you how to:
6464
You will need the following:
6565
- A Xilinx account — create one [here](https://www.xilinx.com/registration/create-account.html)
6666
- A Linux computer running either:
67-
- Red Hat Enterprise Workstation/Server 7.3-7.4 (64-bit)
68-
- CentOS 7.2
69-
- CentOS 7.3-7.4 (64-bit)
70-
- Ubuntu Linux 16.04.3 LTS (64-bit)
71-
- Linux kernel 4.4.0 is supported
72-
- Ubuntu LTS enablement (also called HWE or Hardware Enablement) is not supported
67+
- Ubuntu 16.04.5 LTS, 18.04.1 LTS
68+
- CentOS 7.4, 7.5, 7.6
69+
- RHEL 7.4, 7.5, 7.6
7370

7471

7572
[**FOLLOW THE INSTRUCTIONS**](STEP5.md)

docs/aws-getting-started/RTL/STEP1.md

+14-9
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Creating, Configuring, and Testing an AWS F1 Instance
1+
# Create, Configure, and Test an AWS F1 Instance
22

33
This module guides you through the following steps:
44

@@ -95,15 +95,18 @@ source <(curl -s https://s3.amazonaws.com/aws-fpga-developer-ami/1.5.0/Scripts/s
9595
The script takes about 10 minutes to run and finishes by setting a password for the 'centos' user.
9696

9797
**IMPORTANT**: Take note of the password generated by the script. You will need it to connect using RDP.
98+
9899
2. Return to the **AWS EC2 dashboard** in your web browser.
100+
99101
3. Select your instance, then from the **Actions** menu, select **Instance State** and then select **Reboot**.
102+
100103
4. Wait a couple of minutes for the instance to complete the reboot cycle.
101104

102105
After you have completed this step, you are ready to connect to the instance using a remote desktop client.
103106

104107
#### Step 3: Connect to the Instance with a Remote Desktop Client
105108

106-
1. From your local machine, start a remote desktop protocol (RDP) client
109+
1. From your local machine, start a remote desktop protocol (RDP) client.
107110
- On Windows: press the **Windows** key and type **mstsc.exe** in the Windows run prompt.
108111
- On Linux: use an RDP client, such as Remmina or Vinagre.
109112
- On macOS: use the Microsoft Remote Desktop v8.0.43 from the Mac App Store. That version offers color depth settings.
@@ -114,7 +117,7 @@ After you have completed this step, you are ready to connect to the instance usi
114117
* Click **Yes** to dismiss the message. The Remote Desktop Connection window opens with a login prompt.
115118
* Log in with the following credentials:
116119
- User: **centos**
117-
- Password: *password generated by the `set_gui.sh` script*
120+
- Password: *password generated by the `setup_gui.sh` script*
118121
* Click **Ok**.
119122

120123
You are now connected to the instance running Centos 7 and the FPGA Developer AMI.
@@ -150,7 +153,7 @@ In this step, you install the necessary files to build and execute applications
150153

151154
## 4. Running the SDAccel 'Hello World' Example on AWS F1
152155

153-
This final section explains how run the SDAccel `helloworld_ocl` example on AWS F1 and confirm that the environment is properly configured.
156+
This final section explains how run the SDAccel `helloworld_c` example on AWS F1 and confirm that the environment is properly configured.
154157

155158
#### Step 1: Set Up the SDAccel Environment
156159

@@ -167,14 +170,14 @@ The SDAccel emulation flows allows testing, profiling, and debugging the applica
167170

168171
1. Run the SW Emulation flow for the SDAccel 'hello world' example:
169172
```bash
170-
cd $SDACCEL_DIR/examples/xilinx/getting_started/host/helloworld_ocl/
173+
cd $SDACCEL_DIR/examples/xilinx/getting_started/host/helloworld_c/
171174
make clean
172175
make check TARGETS=sw_emu DEVICES=$AWS_PLATFORM all
173176
```
174177

175178
2. Run the HW Emulation flow for the SDAccel 'hello world' example:
176179
```bash
177-
cd $SDACCEL_DIR/examples/xilinx/getting_started/host/helloworld_ocl/
180+
cd $SDACCEL_DIR/examples/xilinx/getting_started/host/helloworld_c/
178181
make clean
179182
make check TARGETS=hw_emu DEVICES=$AWS_PLATFORM all
180183
```
@@ -190,12 +193,12 @@ Building these files is a two-step process. First SDAccel is used to build the h
190193

191194
1. Build the host application and the &ast;.xclbin (Xilinx FPGA binary file):
192195
```bash
193-
cd $SDACCEL_DIR/examples/xilinx/getting_started/host/helloworld_ocl/
196+
cd $SDACCEL_DIR/examples/xilinx/getting_started/host/helloworld_c/
194197
make clean
195198
make TARGETS=hw DEVICES=$AWS_PLATFORM all
196199
```
197200

198-
2. Create the AWS FPGA binary and AFI from the `*.xclbin` (Xilinx FPGA binary file):
201+
2. Create the AWS FPGA binary and AFI from the &ast;.xclbin (Xilinx FPGA binary file):
199202
```bash
200203
cd xclbin
201204
$SDACCEL_DIR/tools/create_sdaccel_afi.sh \
@@ -237,9 +240,11 @@ aws ec2 describe-fpga-images --fpga-image-ids <AFI ID>
237240

238241
#### Step 5: Execute the Host Application
239242

243+
:warning: **IMPORTANT** : The previous steps do not require an AWS EC2 F1 instance. They can be executed on other AWS EC2 instances such as C4 or C5. However, the steps that follow must be performed on an AWS EC2 F1 instance. You will receive error messages if you do not perform the following steps on an F1 instance.
244+
240245
1. Execute the following commands in the instance terminal:
241246
```bash
242-
cd $SDACCEL_DIR/examples/xilinx/getting_started/host/helloworld_ocl/
247+
cd $SDACCEL_DIR/examples/xilinx/getting_started/host/helloworld_c/
243248
sudo sh
244249
source /opt/xilinx/xrt/setup.sh
245250
./helloworld

docs/aws-getting-started/RTL/STEP2.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ The command will return **Available** when the AFI is created, registered, and r
245245

246246
```json
247247
State: {
248-
"Code" : Available"
248+
"Code" : Available
249249
}
250250
```
251251

0 commit comments

Comments
 (0)