Skip to content

Commit 1023490

Browse files
authored
rc/2.0.7 (#707)
* rc 2.0.7 * Add callout to jinhyeok0410 for helping us with issue 706
1 parent c133a59 commit 1023490

38 files changed

+1209
-244
lines changed

ERRATA.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Shell errata is [documented here](./hdk/docs/AWS_Shell_ERRATA.md)
77

88
## HDK
99

10+
1011
1. Address Aliasing Bug in AMD HBM IP with Customer Address Mapping
1112

1213
* An address aliasing bug has been identified in AMD HBM IP when the IP's "Customer Address Map" option is enabled for a 16GB HBM implementation. The bug allows a single memory entry to be accessed via two different addresses, which might lead to data corruption. More information about this bug will be published by AMD in the Ultrascale+ product errata.
@@ -36,6 +37,9 @@ Shell errata is [documented here](./hdk/docs/AWS_Shell_ERRATA.md)
3637

3738
7. AFIs created based on HDK XDMA shell or Vitis are not supported on F2 instances at this time.
3839

40+
8. HBM simulation using XSIM requires a fix described in this [AMD Answer Record](https://adaptivesupport.amd.com/s/article/000035639?language=en_US).
41+
42+
3943
## SDK
4044

4145
## Software defined Accelerator Development (Vitis)

RELEASE_NOTES.md

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

3+
## v2.0.7
4+
5+
* Documentation updates to improve [ReadTheDocs](https://awsdocs-fpga-f2.readthedocs-hosted.com/latest/) navigation and inline snippets.
6+
* XSIM template script update to extend the waveform dump time.
7+
* Added section with instructions for assigning custom PCIe IDs to HDK [README](./hdk/README.md).
8+
* Added supplementary XDMA driver installation [guide](./hdk/docs/XDMA_Install.md)
9+
* Updated [ERRATA](./ERRATA.md#hdk) with fix for XSIM when simulating HBM.
10+
* Revised the [Vitis README](./vitis/README.md) with updated code snippets, more detail about the XRT setup, and a new guided example of the Hardware Emulation workflow.
11+
* Fixed HDK DCP Tarball path issue described in [#706](https://github.com/aws/aws-fpga/issues/706).
12+
313
## v2.0.6
414

515
* Releasing [CL_SDE software examples](./hdk/cl/examples/cl_sde/software/src/README.md) to demonstrate how to use the [Streaming Data Engine (SDE)](./sdk/apps/virtual-ethernet/doc/SDE_HW_Guide.md) DMA on [small shell](./User_Guide_AWS_EC2_FPGA_Development_Kit.md#aws-shells).

User_Guide_AWS_EC2_FPGA_Development_Kit.md

Lines changed: 74 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ The development kit includes example designs to get you familiar with developing
99
- [Comparison to F1](#comparison-to-f1)
1010
- [AWS EC2 F2 FPGA Development Kit](#aws-ec2-f2-fpga-development-kit)
1111
- [Development Environments](#development-environments)
12+
- [Example Links](#example-links)
1213
- [AWS Shells](#aws-shells)
1314
- [Hardware Development Kit (HDK)](#hardware-development-kit-hdk)
1415
- [Software-Defined Development Environment](#software-defined-development-environment)
15-
- [Additional Vitis Documentation](#additional-vitis-documentation)
1616
- [FPGA Developer AMI](#fpga-developer-ami)
1717
- [Getting Started](#getting-started)
1818
- [Getting Familiar with AWS](#getting-familiar-with-aws)
@@ -44,11 +44,82 @@ This table lists the F2 development flows currently enabled and supported in the
4444

4545
| Development Environment | Description | Accelerator Language | Hardware Interface | Debug Options | Typical Developer |
4646
| ------------------------|-------------|----------------------|--------------------|---------------|-------------------|
47-
| [Hardware accelerator development using Vivado](hdk/README.md) | This environment supports the Hardware Development Kit (HDK) design flow, which empowers FPGA developers to create accelerator designs from scratch, using HDL source code and IPs. <br><br>The AMD Vivado tool synthesizes, implements, and generates the Design Check Point (DCP) file used in F2 AFI creation. AWS FPGA developers benefit from the suite of scripts supplied in the HDK that help to automate different design steps. This allows for flexibility in architecting, implementing, and optimizing accelerator designs while using the HDK.| Verilog/SystemVerilog/VHDL | User-implemented DMA engine or Streaming Data Engine (SDE) | Simulation | Hardware developers with advanced FPGA experience |
47+
| Hardware accelerator development using Vivado (HDK) | This environment supports the Hardware Development Kit (HDK) design flow, which empowers FPGA developers to create accelerator designs from scratch, using HDL source code and IPs. <br><br>The AMD Vivado tool synthesizes, implements, and generates the Design Check Point (DCP) file used in F2 AFI creation. AWS FPGA developers benefit from the suite of scripts supplied in the HDK that help to automate different design steps. This allows for flexibility in architecting, implementing, and optimizing accelerator designs while using the HDK.| Verilog/SystemVerilog/VHDL | User-implemented DMA engine or Streaming Data Engine (SDE) | Simulation | Hardware developers with advanced FPGA experience |
4848
| Hardware accelerator development using Vitis | This environment supports the Vitis design flow, which enables software developers to write C++ code, which may then be compiled into RTL and used in cycle-accurate hardware simulation. After it may then be built into an accelerator design. This step is not necessary, but is encouraged. Vitis may also be used to implement accelerator designs from scratch, using HDL and IPs directly, similar to Vivado. Vitis offers additional analysis tools to aid in the refinement of designs. | Verilog/System Verilog/VHDL | XDMA Engine (coming soon) | Hardware Emulation | Advanced software developers or hardware developers with intermediate to advanced FPGA experience |
4949

5050
On-premise environment: Customers can set up a on-premise development environment using 2024.1 AMD tools with their own licenses. Refer to this guide [here](./hdk/docs/on_premise_licensing_help.md) for licensing requirements.
5151

52+
### Example Links
53+
54+
<!-- markdownlint-disable MD033 -->
55+
<table style="text-align: center">
56+
<tr>
57+
<th style="text-align: center">Development Environment</th>
58+
<th style="text-align: center">Example</th>
59+
<th style="text-align: center">Quick Start Guide</th>
60+
<th style="text-align: center">Resources</th>
61+
</tr>
62+
<tr>
63+
<td style="text-align: center" rowspan="12">HDK</td>
64+
<td style="text-align: center" rowspan="4"><a href="https://github.com/aws/aws-fpga/tree/f2/hdk/cl/examples/cl_mem_perf">cl_mem_perf</a></td>
65+
<td style="text-align: center" rowspan="4"><a href="./hdk/README.md#build-accelerator-afi-using-hdk-design-flow">Guided Example</a></td>
66+
<td style="text-align: center"><a href="./hdk/cl/examples/cl_mem_perf/README.md">Design Spec</a></td>
67+
</tr>
68+
<tr>
69+
<td style="text-align: center"><a href="./hdk/cl/examples/cl_mem_perf/design/">Design Source Code</a></td>
70+
</tr>
71+
<tr>
72+
<td style="text-align: center"><a href="./hdk/cl/examples/cl_mem_perf/verif/">Testbench</a></td>
73+
</tr>
74+
<tr>
75+
<td style="text-align: center"><a href="./hdk/cl/examples/cl_mem_perf/software/">Runtime Software</a></td>
76+
</tr>
77+
<tr>
78+
<td style="text-align: center" rowspan="4"><a href="https://github.com/aws/aws-fpga/tree/f2/hdk/cl/examples/cl_dram_hbm_dma">cl_dram_hbm_dma</a></td>
79+
<td style="text-align: center" rowspan="4"></td>
80+
<td style="text-align: center"><a href="./hdk/cl/examples/cl_dram_hbm_dma/README.md">Design Spec</a></td>
81+
</tr>
82+
<tr>
83+
<td style="text-align: center"><a href="./hdk/cl/examples/cl_dram_hbm_dma/design/">Design Source</a></td>
84+
</tr>
85+
<tr>
86+
<td style="text-align: center"><a href="./hdk/cl/examples/cl_dram_hbm_dma/verif/">Testbench</a></td>
87+
</tr>
88+
<tr>
89+
<td style="text-align: center"><a href="./hdk/cl/examples/cl_dram_hbm_dma/software/">Runtime Software</a></td>
90+
</tr>
91+
<tr>
92+
<td style="text-align: center" rowspan="4"><a href="https://github.com/aws/aws-fpga/tree/f2/hdk/cl/examples/cl_sde">cl_sde</a></td>
93+
<td style="text-align: center" rowspan="4"></td>
94+
<td style="text-align: center"><a href="./hdk/cl/examples/cl_sde/README.md">Design Spec</a></td>
95+
</tr>
96+
<tr>
97+
<td style="text-align: center"><a href="./hdk/cl/examples/cl_sde/design/">Design Source</a></td>
98+
</tr>
99+
<tr>
100+
<td style="text-align: center"><a href="./hdk/cl/examples/cl_sde/verif/">Testbench</a></td>
101+
</tr>
102+
<tr>
103+
<td style="text-align: center"><a href="./hdk/cl/examples/cl_sde/software/">Runtime Software</a></td>
104+
</tr>
105+
<tr>
106+
<td style="text-align: center" rowspan="4">Vitis</td>
107+
<td style="text-align: center" rowspan="4"><a href="https://github.com/Xilinx/Vitis_Accel_Examples/tree/2024.1/hello_world">hello_world</a></td>
108+
<td style="text-align: center" rowspan="4"><a href="./vitis/README.md">Guided Example</td>
109+
<td style="text-align: center"><a href="https://github.com/Xilinx/Vitis_Accel_Examples/blob/main/hello_world/README.rst">Design Spec</a></td>
110+
</tr>
111+
<tr>
112+
<td style="text-align: center"><a href="https://github.com/Xilinx/Vitis_Accel_Examples/blob/main/hello_world/src/vadd.cpp">Design Source</a></td>
113+
</tr>
114+
<tr>
115+
<td style="text-align: center"><a href="https://github.com/Xilinx/Vitis_Accel_Examples/blob/main/hello_world/src/host.cpp#L92">Testbench</a></td>
116+
</tr>
117+
<tr>
118+
<td style="text-align: center"><a href="https://github.com/Xilinx/Vitis_Accel_Examples/blob/main/hello_world/src/host.cpp">Runtime Software</a></td>
119+
</tr>
120+
121+
</table>
122+
52123
### AWS Shells
53124

54125
For AWS EC2 F2 FPGA instances, each FPGA is divided into two partitions:
@@ -105,7 +176,7 @@ A free-to-use FPGA developer AMI is available for on-cloud F2 development with A
105176

106177
| FPGA Developer AMI Version | FPGA Developer AMI ID | Vivado/Vitis Version Supported | Operating System Version |
107178
|----------------------------|-----------------------|--------------------------------|-----------------------------|
108-
| 1.16.0 | [ami-0e6383ac30e23cf97](https://aws.amazon.com/marketplace/pp/prodview-f5kjsenkfkz5u) | 2024.1 | Ubuntu 20.04.6 (kernel 5.15)|
179+
| 1.16.1 | [ami-092fc5deb8f3c0f7d](https://aws.amazon.com/marketplace/pp/prodview-f5kjsenkfkz5u) | 2024.1 | Ubuntu 20.04.6 (kernel 5.15)|
109180

110181
Given the large size of the FPGA used for F2, AMD tools work best with at least 4 vCPU’s and 32GiB Memory. We recommend [Compute Optimized and Memory Optimized instance types](https://aws.amazon.com/ec2/instance-types/) to successfully run the synthesis of acceleration code. Developers may start coding and run simulations on low-cost `General Purpose` [instances types](https://aws.amazon.com/ec2/instance-types/).
111182

docs-rtd/requirements.txt

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
1-
sphinx>=6.1.0
1+
sphinx>=6.1.0,<9.0.0
2+
sphinx_book_theme>=1.1.3,<2.0.0
3+
sphinx-sitemap==2.6.0
4+
5+
sphinxcontrib-spelling==8.0.1
26
pyenchant==3.2.2
7+
docutils>=0.18,<0.21
8+
9+
sphinx-copybutton>=0.5.2
10+
311
termcolor==2.5.0
4-
sphinxcontrib-spelling==8.0.1
5-
sphinx_book_theme>=1.1.3
612
requests==2.32.3

docs-rtd/source/ERRATA.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Shell Errata
66

77
Shell errata is `documented here <./hdk/docs/AWS-Shell-ERRATA.html>`__
88

9+
.. _hdk-errata:
10+
911
HDK
1012
---
1113

@@ -63,6 +65,9 @@ HDK
6365
7. AFIs created based on HDK XDMA shell or Vitis are not supported on F2
6466
instances at this time.
6567

68+
8. HBM simulation using XSIM requires a fix described in this
69+
`AMD Answer Record <https://adaptivesupport.amd.com/s/article/000035639?language=en_US>`__.
70+
6671
SDK
6772
---
6873

@@ -77,4 +82,4 @@ Software defined Accelerator Development (Vitis)
7782

7883
3. Support for Vitis software emulation has been deprecated by AMD, therefore, no longer supported.
7984

80-
`Back to Home <./home.html>`__
85+
`Back to Home <./index.html>`__

docs-rtd/source/RELEASE-NOTES.rst

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

4+
5+
.. _v207:
6+
7+
v2.0.7
8+
------
9+
10+
- Documentation updates to improve `ReadTheDocs <https://awsdocs-fpga-f2.readthedocs-hosted.com/latest>`__ navigation and inline snippets.
11+
- XSIM template script update to extend the waveform dump time.
12+
- Added section with instructions for assigning custom PCIe IDs to HDK `README <./hdk/README.html>`__.
13+
- Added supplementary XDMA driver installation `guide <./hdk/docs/XDMA-Install.html>`__
14+
- Updated `ERRATA <./ERRATA.html#hdk-errata>`__ with fix for XSIM when simulating HBM.
15+
- Revised the `Vitis README <./vitis/README.html>`__ with updated code snippets, more detail about the XRT setup, and a new guided example of the Hardware Emulation workflow.
16+
- Fixed HDK DCP Tarball path issue described in `#706 <https://github.com/aws/aws-fpga/issues/706>`__.
17+
418
.. _v206:
519

620
v2.0.6
@@ -99,4 +113,4 @@ v2.0.0
99113

100114
Initial release. F2 general-availability companion.
101115

102-
`Back to Home <./home.html>`__
116+
`Back to Home <./index.html>`__

docs-rtd/source/User-Guide-AWS-EC2-FPGA-Development-Kit.rst

Lines changed: 85 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,12 @@ developing for AWS EC2 FPGA Instances.
1717
Kit <#aws-ec2-f2-fpga-development-kit>`__
1818

1919
- `Development Environments <#development-environments>`__
20+
- `Example Links <#example-links>`__
2021
- `AWS Shells <#aws-shells>`__
2122
- `Hardware Development Kit (HDK) <#hardware-development-kit-hdk>`__
2223
- `Software-Defined Development
2324
Environment <#software-defined-development-environment>`__
2425

25-
- `Additional Vitis
26-
Documentation <#additional-vitis-documentation>`__
2726
- `FPGA Developer AMI <#fpga-developer-ami>`__
2827

2928
- `Getting Started <#getting-started>`__
@@ -100,7 +99,7 @@ supported in the development kit.
10099
- Hardware interface
101100
- Debug Options
102101
- Typical Developer
103-
* - `Hardware accelerator development using Vivado <./hdk/README.html>`__
102+
* - Hardware accelerator development using Vivado (HDK)
104103
- This environment supports the Hardware Development Kit (HDK) design flow,
105104
which empowers FPGA developers to create accelerator designs from scratch,
106105
using HDL source code and IPs. The AMD Vivado tool synthesizes, implements,
@@ -113,7 +112,7 @@ supported in the development kit.
113112
- User-implemented DMA engine or Streaming Data Engine (SDE)
114113
- Simulation
115114
- Hardware developers with advanced FPGA experience
116-
* - `Hardware accelerator development using Vitis <./vitis/README.html>`__
115+
* - Hardware accelerator development using Vitis
117116
- This environment supports the Vitis design flow,
118117
which enables software developers to write C++ code,
119118
which may then be compiled into RTL and used in
@@ -135,6 +134,85 @@ environment using 2024.1 AMD tools with their own licenses. Refer to
135134
this guide `here <./hdk/docs/on-premise-licensing-help.html>`__ for
136135
licensing requirements.
137136

137+
.. _example-links:
138+
139+
Example Links
140+
~~~~~~~~~~~~~
141+
142+
.. list-table::
143+
:header-rows: 1
144+
:widths: 15 15 30 35
145+
146+
* - Development Environment
147+
- Example
148+
- Quick-Start Guide
149+
- Resources
150+
* - HDK
151+
- `cl_mem_perf <https://github.com/aws/aws-fpga/tree/f2/hdk/cl/examples/cl_mem_perf>`__
152+
- `Guided Example <./hdk/README.html#getting-started-hdk>`__
153+
- `Design Spec <./hdk/cl/examples/cl-mem-perf/README.html>`__
154+
* -
155+
-
156+
-
157+
- `Design Source Code <https://github.com/aws/aws-fpga/tree/f2/hdk/cl/examples/cl_mem_perf/design>`__
158+
* -
159+
-
160+
-
161+
- `Testbench <https://github.com/aws/aws-fpga/tree/f2/hdk/cl/examples/cl_mem_perf/verif>`__
162+
* -
163+
-
164+
-
165+
- `Runtime Software <https://github.com/aws/aws-fpga/tree/f2/hdk/cl/examples/cl_mem_perf/software>`__
166+
* -
167+
- `cl_dram_hbm_dma <https://github.com/aws/aws-fpga/tree/f2/hdk/cl/examples/cl_dram_hbm_dma>`__
168+
-
169+
- `Design Spec <./hdk/cl/examples/cl-dram-hbm-dma/README.html>`__
170+
* -
171+
-
172+
-
173+
- `Design Source Code <https://github.com/aws/aws-fpga/tree/f2/hdk/cl/examples/cl_dram_hbm_dma/design>`__
174+
* -
175+
-
176+
-
177+
- `Testbench <https://github.com/aws/aws-fpga/tree/f2/hdk/cl/examples/cl_dram_hbm_dma/verif>`__
178+
* -
179+
-
180+
-
181+
- `Runtime Software <https://github.com/aws/aws-fpga/tree/f2/hdk/cl/examples/cl_dram_hbm_dma/software>`__
182+
* -
183+
- `cl_sde <https://github.com/aws/aws-fpga/tree/f2/hdk/cl/examples/cl_sde>`__
184+
-
185+
- `Design Spec <./hdk/cl/examples/cl-sde/README.html>`__
186+
* -
187+
-
188+
-
189+
- `Design Source Code <https://github.com/aws/aws-fpga/tree/f2/hdk/cl/examples/cl_sde/design>`__
190+
* -
191+
-
192+
-
193+
- `Testbench <https://github.com/aws/aws-fpga/tree/f2/hdk/cl/examples/cl_sde/verif>`__
194+
* -
195+
-
196+
-
197+
- `Runtime Software <https://github.com/aws/aws-fpga/tree/f2/hdk/cl/examples/cl_sde/software>`__
198+
* - Vitis
199+
- `hello_world <https://github.com/Xilinx/Vitis_Accel_Examples/tree/2024.1/hello_world>`__
200+
- `Guided Example <./vitis/README.html>`__
201+
- `Design Spec <https://github.com/Xilinx/Vitis_Accel_Examples/blob/main/hello_world/README.rst>`__
202+
* -
203+
-
204+
-
205+
- `Design Source Code <https://github.com/Xilinx/Vitis_Accel_Examples/blob/main/hello_world/src/vadd.cpp>`__
206+
* -
207+
-
208+
-
209+
- `Testbench <https://github.com/Xilinx/Vitis_Accel_Examples/blob/main/hello_world/src/host.cpp#L92>`__
210+
* -
211+
-
212+
-
213+
- `Runtime Software <https://github.com/Xilinx/Vitis_Accel_Examples/blob/main/hello_world/src/host.cpp>`__
214+
215+
138216
.. _aws-shells:
139217

140218
AWS Shells
@@ -262,8 +340,8 @@ currently released to customers:
262340
- FPGA Developer AMI ID
263341
- Vivado/Vitis Version Supported
264342
- Operating System Version
265-
* - 1.16.0
266-
- `ami-0e6383ac30e23cf97 <https://aws.amazon.com/marketplace/pp/prodview-f5kjsenkfkz5u>`__
343+
* - 1.16.1
344+
- `ami-092fc5deb8f3c0f7d <https://aws.amazon.com/marketplace/pp/prodview-f5kjsenkfkz5u>`__
267345
- 2024.1
268346
- Ubuntu 20.04.6 (kernel 5.15)
269347

@@ -332,4 +410,4 @@ FPGA Development Kit:
332410
.. |image1| image:: ./_static/accel_card_specs_20250110.png
333411
.. |f2_f1_comp| image:: ./_static/f2_f1_comp_20250110.png
334412

335-
`Back to Home <./home.html>`__
413+
`Back to Home <./index.html>`__
Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
{% extends "!layout.html" %}
22
{% block extrahead %}
33
{{ super() }}
4-
{% if pagename == 'welcome' %}
5-
<meta name="google-site-verification" content="8Towr1qSHYbKJeNUM4gRR3T13Rbh895fJjuafp8Hc10" />
6-
{% endif %}
4+
<meta name="google-site-verification" content="8Towr1qSHYbKJeNUM4gRR3T13Rbh895fJjuafp8Hc10" />
75
{% endblock %}

docs-rtd/source/all-links.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,4 +120,4 @@ Release Notes and Errata
120120
RELEASE-NOTES
121121
ERRATA
122122

123-
`Back to Home <./home.html>`__
123+
`Back to Home <./index.html>`__

0 commit comments

Comments
 (0)