Skip to content

Commit 82ddb6c

Browse files
TrahStevAmzTrahStevAmz
authored
rc v2.1.1 (#730)
* Added global register offset for the SDE IP. * Added CL_SDE software exmaple for a user allocated DMA buffer. * Documentation to assist F2 customers with releasing AFIs and AMIs on the AWS Marketplace. * Documentation to assist in creating a virtual desktop based on the FPGA Developer AMI running graphics-intensive applications remotely on Amazon EC2 instances. * Fixed the BW calculation and tolerance calculation in the test_hbm_perf_random in the cl_mem_perf.
1 parent ca698e2 commit 82ddb6c

36 files changed

+833
-284
lines changed

‎RELEASE_NOTES.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# F2 Developer Kit Release Notes
22

3+
## v2.1.1
4+
5+
* Added global register offset for the SDE IP. See [CL_SDE software examples](./hdk/cl/examples/cl_sde/software/src/README.md).
6+
* Added [CL_SDE software exmaple](./hdk/cl/examples/cl_sde/software/src/sde_c2h_user_buffers.c) for a user allocated DMA buffer.
7+
* [Documentation](./hdk/docs/List_AFI_on_Marketplace.md) to assist F2 customers with releasing AFIs and AMIs on the AWS Marketplace.
8+
* [Documentation](./developer_resources/Amazon_DCV_Setup_Guide.md) to assist in creating a virtual desktop based on the FPGA Developer AMI running graphics-intensive applications remotely on Amazon EC2 instances.
9+
* Fixed the BW calculation and tolerance calculation in the test_hbm_perf_random in the [cl_mem_perf](./hdk/cl/examples/cl_mem_perf/verif/README.md#test_hbm_perf_randomsv).
10+
311
## v2.1.0
412

513
* Support for Vivado and Vitis 2024.2 tools.

‎developer_resources/Amazon_DCV_Setup_Guide.md

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
# Using EC2 Instances with a GUI
2+
3+
## Table of Contents
4+
5+
- [What is Amazon DCV?](#what-is-amazon-dcv)
6+
- [Installing the Amazon DCV Server on an Amazon EC2 Instance](#installing-the-amazon-dcv-server-on-an-amazon-ec2-instance)
7+
- [Prerequisites](#prerequisites)
8+
- [Amazon DCV Server Installation](#amazon-dcv-server-installation)
9+
- [Post-Installation Checks](#post-installation-checks)
10+
- [Setting a Password for Your Sessions](#setting-a-password-for-your-sessions)
11+
- [Setting Security Rules to Allow Traffic on Port 8443](#setting-security-rules-to-allow-traffic-on-port-8443)
12+
- [Amazon DCV Client Installation](#amazon-dcv-client-installation)
13+
- [Basic Session Management](#basic-session-management)
14+
- [Quick Session Startup](#quick-session-startup)
15+
16+
## What is Amazon DCV?
17+
18+
[Amazon DCV](https://docs.aws.amazon.com/dcv/latest/adminguide/what-is-dcv.html) is a high-performance remote
19+
display protocol that provides customers with a secure way to deliver remote desktops and application streaming
20+
from any cloud or data center to any device, over varying network conditions. With Amazon DCV and Amazon EC2,
21+
customers can run graphics-intensive applications remotely on EC2 instances and stream the results to simpler
22+
client machines, eliminating the need for expensive dedicated workstations.
23+
24+
This guide helps customers developing for AWS F2 instances create a virtual desktop running on EC2 instances
25+
based on the [FPGA Developer AMI](../User_Guide_AWS_EC2_FPGA_Development_Kit.md#fpga-developer-ami).
26+
The FPGA Developer AMI has pre-installed tools which are license free. Combined with DCV, this enables
27+
development using Vivado or Vitis' graphical Integrated Design Environment (IDE), which provides an intuitive
28+
graphical user interface (GUI) to visualize FPGA development in the cloud.
29+
30+
## Installing the Amazon DCV Server on an Amazon EC2 Instance
31+
32+
### Prerequisites
33+
34+
1. [Depenency Installation](https://docs.aws.amazon.com/dcv/latest/adminguide/setting-up-installing-linux-prereq.html#linux-prereq-gui)
35+
* :warning: DO NOT PERFORM STEP 3! Upgrading may impact the stability of development kit software!
36+
2. [Protocol Setup](https://docs.aws.amazon.com/dcv/latest/adminguide/setting-up-installing-linux-prereq.html#linux-prereq-wayland)
37+
3. [Driver Installation](https://docs.aws.amazon.com/dcv/latest/adminguide/setting-up-installing-linux-prereq.html#linux-prereq-nongpu)
38+
39+
### Amazon DCV Server Installation
40+
41+
In the [install procedure described here](https://docs.aws.amazon.com/dcv/latest/adminguide/setting-up-installing-linux-server.html#linux-server-install), follow steps 1 through 5, 7, and 8.
42+
When you get to step 9, do the following:
43+
44+
``` bash
45+
sudo apt --fix-broken install
46+
sudo apt install -y mesa-utils
47+
sudo dpkg -i nice-dcv-gl_2024.0.1096-1_amd64.ubuntu<2404 or 2004>.deb
48+
```
49+
50+
### Post-Installation Checks
51+
52+
[This section of the post-installation check](https://docs.aws.amazon.com/dcv/latest/adminguide/setting-up-installing-linux-checks.html#checks-xserver) should be run to ensure that all aspects of the setup are working as expected.
53+
54+
### Setting a Password for Your Sessions
55+
56+
In order to connect to an Amazon DCV session, you must have a password set for your user on the EC2 instance.
57+
This can be done with this command:
58+
59+
``` bash
60+
sudo passwd $USER
61+
```
62+
63+
### Setting Security Rules to Allow Traffic on Port 8443
64+
65+
In order for Amazon DCV to communicate with your EC2 instance, TCP and UDP traffic must be allowed on port 8443.
66+
This can be accomplished by updating the security group you used to launch your instance.
67+
68+
## Amazon DCV Client Installation
69+
70+
The [Amazon DCV client](https://www.amazondcv.com/) should be installed on your local machine and is used to view your virtual desktop on your EC2 instance.
71+
72+
## Basic Session Management
73+
74+
To begin, run the following two commands:
75+
76+
``` bash
77+
sudo systemctl isolate multi-user.target (Ubuntu 20.04 only)
78+
sudo systemctl restart dcvserver.service
79+
sudo systemctl restart dcvsessionlauncher.service
80+
```
81+
82+
Next, refer to the [session management user guide here](https://docs.aws.amazon.com/dcv/latest/adminguide/managing-sessions.html). This guide will provide you with all of the information you need to customize and manage your Amazon DCV sessions.
83+
84+
### Quick Session Startup
85+
86+
To start a session, use the following command:
87+
88+
``` bash
89+
dcv create-session $your_session_number
90+
dcv list-sessions
91+
Session: '1' (owner:ubuntu type:virtual)
92+
```
93+
94+
You may give your session any number you like, but no two sessions may have the same number.
95+
96+
From this point, you can access your session using the Amazon DCV client on your local machine or via the [DCV console in your web browser](https://docs.aws.amazon.com/dcv/latest/userguide/using-connecting-browser-connect.html).
97+
98+
Enter `https://user@ec2_instance_ip_address:8443` into the `Hostname or IP Address` box and click `Connect`. Next, click "Trust and Connect".
99+
100+
Enter the password you set in [Post-Installation Checks](#post-installation-checks) in the `Password` box and click `Login`.
101+
102+
At this point, you should see your session begin and a virtual desktop displayed after a brief delay.
103+
104+
Any popups about not having a license may be safely ignored. This is a known issue with DCV.
105+
106+
Now, open a terminal and run the following command: `source /etc/profile.d/default_module.sh`. You're now ready to use your GUI-enabled EC2 Instance.
107+
108+
``` bash
109+
ubuntu@ip-1-2-3-4:~$ source /etc/profile.d/default_module.sh
110+
ubuntu@ip-1-2-3-4:~$ vivado -version
111+
vivado v2024.1 (64-bit)
112+
```

‎developer_resources/DCV.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎docs-rtd/source/RELEASE-NOTES.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
11
F2 Developer Kit Release Notes
22
==============================
33

4+
.. _v211:
5+
6+
v2.1.1
7+
------
8+
9+
- Added global register offset for the SDE IP. See `CL_SDE software examples <./hdk/cl/examples/cl-sde/software/src/README.html>`__.
10+
- Added `CL_SDE software exmaple <https://github.com/aws/aws-fpga/blob/f2/hdk/cl/examples/cl_sde/software/src/sde_c2h_user_buffers.c>`__ for a user allocated DMA buffer.
11+
- `Documentation <./hdk/docs/List-AFI-on-Marketplace.html>`__` to assist F2 customers with releasing AFIs and AMIs on the AWS Marketplace.
12+
- `Documentation <./developer-resources/Amazon-DCV-Setup-Guide.html>`__ to assist in creating a virtual desktop based on the FPGA Developer AMI running graphics-intensive applications remotely on Amazon EC2 instances.
13+
- Fixed the BW calculation and tolerance calculation in the test_hbm_perf_random in the `cl_mem_perf <./hdk/cl/examples/cl-mem-perf/verif/README.html#test-hbm-perf-randomsv-mem>`__.
14+
415
.. _v210:
516

617
v2.1.0

‎docs-rtd/source/all-links.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ General Documentation
7070
hdk/docs/AWS-Shell-ERRATA
7171
hdk/docs/AWS-Shell-Interface-Specification
7272
hdk/docs/Clock-Recipes-User-Guide
73+
hdk/docs/List-AFI-on-Marketplace
7374
hdk/docs/on-premise-licensing-help
7475
hdk/docs/RTL-Simulation-Guide-for-HDK-Design-Flow
7576
hdk/docs/shell-floorplan

‎docs-rtd/source/developer-resources/Amazon-DCV-Setup-Guide.rst

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
Using EC2 Instances with a GUI
2+
==============================
3+
4+
Table of Contents
5+
-----------------
6+
7+
- `What is Amazon DCV? <#what-is-amazon-dcv>`__
8+
- `Installing the Amazon DCV Server on an Amazon EC2
9+
Instance <#installing-the-amazon-dcv-server-on-an-amazon-ec2-instance>`__
10+
11+
- `Prerequisites <#prerequisites>`__
12+
- `Amazon DCV Server Installation <#amazon-dcv-server-installation>`__
13+
- `Post-Installation Checks <#post-installation-checks>`__
14+
- `Setting a Password for Your
15+
Sessions <#setting-a-password-for-your-sessions>`__
16+
- `Setting Security Rules to Allow Traffic on Port
17+
8443 <#setting-security-rules-to-allow-traffic-on-port-8443>`__
18+
19+
- `Amazon DCV Client Installation <#amazon-dcv-client-installation>`__
20+
- `Basic Session Management <#basic-session-management>`__
21+
22+
- `Quick Session Startup <#quick-session-startup>`__
23+
24+
What is Amazon DCV?
25+
-------------------
26+
27+
`Amazon
28+
DCV <https://docs.aws.amazon.com/dcv/latest/adminguide/what-is-dcv.html>`__
29+
is a high-performance remote display protocol that provides customers
30+
with a secure way to deliver remote desktops and application streaming
31+
from any cloud or data center to any device, over varying network
32+
conditions. With Amazon DCV and Amazon EC2, customers can run
33+
graphics-intensive applications remotely on EC2 instances and stream the
34+
results to simpler client machines, eliminating the need for expensive
35+
dedicated workstations.
36+
37+
This guide helps customers developing for AWS F2 instances create a
38+
virtual desktop running on EC2 instances based on the `FPGA Developer
39+
AMI <../User-Guide-AWS-EC2-FPGA-Development-Kit.html#fpga-developer-ami>`__.
40+
The FPGA Developer AMI has pre-installed tools which are license free.
41+
Combined with DCV, this enables development using Vivado or Vitis'
42+
graphical Integrated Design Environment (IDE), which provides an
43+
intuitive graphical user interface (GUI) to visualize FPGA development
44+
in the cloud.
45+
46+
Installing the Amazon DCV Server on an Amazon EC2 Instance
47+
----------------------------------------------------------
48+
49+
Prerequisites
50+
~~~~~~~~~~~~~
51+
52+
1. `Depenency
53+
Installation <https://docs.aws.amazon.com/dcv/latest/adminguide/setting-up-installing-linux-prereq.html#linux-prereq-gui>`__
54+
55+
- ⚠️ DO NOT PERFORM STEP 3! Upgrading may impact the stability of
56+
development kit software!
57+
58+
2. `Protocol
59+
Setup <https://docs.aws.amazon.com/dcv/latest/adminguide/setting-up-installing-linux-prereq.html#linux-prereq-wayland>`__
60+
3. `Driver
61+
Installation <https://docs.aws.amazon.com/dcv/latest/adminguide/setting-up-installing-linux-prereq.html#linux-prereq-nongpu>`__
62+
63+
Amazon DCV Server Installation
64+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
65+
66+
In the `install procedure described
67+
here <https://docs.aws.amazon.com/dcv/latest/adminguide/setting-up-installing-linux-server.html#linux-server-install>`__,
68+
follow steps 1 through 5, 7, and 8. When you get to step 9, do the
69+
following:
70+
71+
.. code:: bash
72+
73+
sudo apt --fix-broken install
74+
sudo apt install -y mesa-utils
75+
sudo dpkg -i nice-dcv-gl_2024.0.1096-1_amd64.ubuntu<2404 or 2004>.deb
76+
77+
Post-Installation Checks
78+
~~~~~~~~~~~~~~~~~~~~~~~~
79+
80+
`This section of the post-installation
81+
check <https://docs.aws.amazon.com/dcv/latest/adminguide/setting-up-installing-linux-checks.html#checks-xserver>`__
82+
should be run to ensure that all aspects of the setup are working as
83+
expected.
84+
85+
Setting a Password for Your Sessions
86+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
87+
88+
In order to connect to an Amazon DCV session, you must have a password
89+
set for your user on the EC2 instance. This can be done with this
90+
command:
91+
92+
.. code:: bash
93+
94+
sudo passwd $USER
95+
96+
Setting Security Rules to Allow Traffic on Port 8443
97+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
98+
99+
In order for Amazon DCV to communicate with your EC2 instance, TCP and
100+
UDP traffic must be allowed on port 8443. This can be accomplished by
101+
updating the security group you used to launch your instance.
102+
103+
Amazon DCV Client Installation
104+
------------------------------
105+
106+
The `Amazon DCV client <https://www.amazondcv.com/>`__ should be
107+
installed on your local machine and is used to view your virtual
108+
desktop on your EC2 instance.
109+
110+
Basic Session Management
111+
------------------------
112+
113+
To begin, run the following two commands:
114+
115+
.. code:: bash
116+
117+
sudo systemctl isolate multi-user.target (Ubuntu 20.04 only)
118+
sudo systemctl restart dcvserver.service
119+
sudo systemctl restart dcvsessionlauncher.service
120+
121+
Next, refer to the `session management user guide
122+
here <https://docs.aws.amazon.com/dcv/latest/adminguide/managing-sessions.html>`__.
123+
This guide will provide you with all of the information you need to
124+
customize and manage your Amazon DCV sessions.
125+
126+
Quick Session Startup
127+
~~~~~~~~~~~~~~~~~~~~~
128+
129+
To start a session, use the following command:
130+
131+
.. code:: bash
132+
133+
dcv create-session $your_session_number
134+
dcv list-sessions
135+
Session: '1' (owner:ubuntu type:virtual)
136+
137+
You may give your session any number you like, but no two sessions may
138+
have the same number.
139+
140+
From this point, you can access your session using the Amazon DCV client
141+
on your local machine or via the `DCV console in your web browser <https://docs.aws.amazon.com/dcv/latest/userguide/using-connecting-browser-connect.html>`__.
142+
143+
Enter ``https://user@ec2_instance_ip_address:8443`` into the
144+
``Hostname or IP Address`` box and click ``Connect``. Next, click "Trust
145+
and Connect".
146+
147+
Enter the password you set in `Post-Installation
148+
Checks <#post-installation-checks>`__ in the ``Password`` box and click
149+
``Login``.
150+
151+
At this point, you should see your session begin and a virtual desktop
152+
displayed after a brief delay.
153+
154+
Any popups about not having a license may be safely ignored. This is a
155+
known issue with DCV.
156+
157+
Now, open a terminal and run the following command:
158+
``source /etc/profile.d/default_module.sh``. You're now ready to use
159+
your GUI-enabled EC2 Instance.
160+
161+
.. code:: bash
162+
163+
ubuntu@ip-1-2-3-4:~$ source /etc/profile.d/default_module.sh
164+
ubuntu@ip-1-2-3-4:~$ vivado -version
165+
vivado v2024.1 (64-bit)

‎docs-rtd/source/developer-resources/DCV.rst

Lines changed: 0 additions & 24 deletions
This file was deleted.

‎docs-rtd/source/hdk/README.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -809,6 +809,7 @@ Additional HDK Documentation
809809
docs/shell-floorplan
810810
docs/AWS-Fpga-Pcie-Memory-Map
811811
docs/RTL-Simulation-Guide-for-HDK-Design-Flow
812+
docs/List-AFI-on-Marketplace
812813
docs/on-premise-licensing-help
813814
docs/Supported-DDR-Modes
814815
docs/Virtual-JTAG-XVC

0 commit comments

Comments
 (0)