Skip to content

Commit 6bb1bda

Browse files
mjthimmmjthimm
authored
Release v2.0.1 (aws#665)
1 parent 8c8783e commit 6bb1bda

File tree

366 files changed

+16644
-3226
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

366 files changed

+16644
-3226
lines changed

‎.readthedocs.yaml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
version: 2
2+
3+
build:
4+
os: ubuntu-20.04
5+
tools:
6+
python: "3.10"
7+
8+
python:
9+
install:
10+
- requirements: docs-rtd/requirements.txt
11+
12+
sphinx:
13+
configuration: docs-rtd/source/conf.py

‎ERRATA.md

+16-8
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,15 @@ Shell errata is [documented here](./hdk/docs/AWS_Shell_ERRATA.md)
77

88
## HDK
99

10-
1. CL simulation might show the following "error" message if the [CL clock generator](./hdk/docs/AWS_CLK_GEN_spec.md) is contained in the design. By default, the generator blocks all output clocks (except for `o_clk_main_a0`) and asserts all output resets. This behavior violates the built-in reset check in the [AXI SmartConnect IP](https://www.xilinx.com/products/intellectual-property/smartconnect.html#overview). This message can be safely ignored. A Fix for this issue is in progress.
10+
1. Support for the XDMA Shell in the HDK design flow is not available at this time. CL builds using the XDMA Shell will result in a build failure.
11+
12+
2. CL simulation might show the following "error" message if the [CL clock generator](./hdk/docs/AWS_CLK_GEN_spec.md) is contained in the design. By default, the generator blocks all output clocks (except for `o_clk_main_a0`) and asserts all output resets. This behavior violates the built-in reset check in the [AXI SmartConnect IP](https://www.xilinx.com/products/intellectual-property/smartconnect.html#overview). This message can be safely ignored. A Fix for this issue is in progress.
1113

1214
```bash
1315
# ** Error: [SmartConnect 500-33] s_sc_aresetn should be asserted for at least 16 cycles of m_sc_aclk. tb.card.fpga.CL.CL_HBM.HBM_PRESENT_EQ_1.AXI_CONVERTER_AXI4_AXI3.cl_axi_sc_1x1_i.smartconnect_0.inst.s00_nodes.s00_aw_node.inst.<protected>.<protected>
1416
```
1517

16-
2. CL simulation might show the following "error" message. This message can be safely ignored. A Fix for this issue is in progress.
18+
3. CL simulation might show the following "error" message. This message can be safely ignored. A Fix for this issue is in progress.
1719

1820
```bash
1921
# Initializing memory from data in 'ddr4_ddr_10.mem'.
@@ -22,11 +24,9 @@ Shell errata is [documented here](./hdk/docs/AWS_Shell_ERRATA.md)
2224
# ERROR: Failed to write data burst length to 16. Only <4,8> are valid.
2325
```
2426

25-
3. XSIM simulator does not support a cycle-accurate simulation model for the HBM IP. We’re observing significantly longer simulation times compared to VCS and Questa simulators. This is caused by the HBM BFM used in XSIM. Therefore, running HBM simulation using VCS or Questa is strongly recommended.
26-
27-
4. XDMA driver interrupt mode doesn't work currently on instances. Runtime examples have temporarily switched to use the polling mode and the interrupt mode test has been temporarily removed. Refer to the [XDMA driver installation guide](./hdk/docs/XDMA_Install.md) for instructions on how to load XDMA driver using the polling mode.
27+
4. XSIM simulator does not support a cycle-accurate simulation model for the HBM IP. We’re observing significantly longer simulation times compared to VCS and Questa simulators. This is caused by the HBM BFM used in XSIM. Therefore, running HBM simulation using VCS or Questa is strongly recommended.
2828

29-
5. The following hdk tests are not supported in XSIM currently and will report not supported warning if ran:
29+
5. The following HDK tests are currently not supported in XSIM and will report not supported warning if ran:
3030

3131
- cl_mem_perf:
3232
- test_dram_dma_4k_crossing
@@ -40,10 +40,18 @@ Shell errata is [documented here](./hdk/docs/AWS_Shell_ERRATA.md)
4040

4141
6. Simulation of the [HBM monitor interface](./hdk/docs/AWS_Shell_Interface_Specification.md/#hbm-monitor-interface) is not supported in this release. The HBM IP always passes initialization and remains in an operating state for all tests. Simulation support for the HBM monitor will be added in a future release.
4242

43-
7. AFIs created based on HDK XDMA shell or Vitis are not supported on F2 instances at this time.
43+
7. AFIs created based on HDK XDMA shell or Vitis are not supported on F2
44+
instances at this time.
45+
46+
8. The following ddr simulation backdoor test is not working with 64GB memory:
47+
- test_ddr_peek_bdr_walking_ones
4448

4549
## SDK
4650

4751
## Software defined Accelerator Development (Vitis)
4852

49-
- Support for 2024.1 and hardware emulation only. Software emulation and F2 instance support is not supported at this time.
53+
1. Only hardware emulation via Vitis 2024.1 is currently supported.
54+
55+
2. Support for Vitis 2024.1 accelerator binary creation and AFI creation is not supported, but will be released at a later time.
56+
57+
3. Support for Vitis software emulation has been deprecated by AMD, therefore, no longer supported.

‎README.md

+4
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ The F2 FPGA Development Kit is a hardware-software development kit that enables
1212

1313
For full documentation, including a user guide, code snippets, and tutorials, see the [AWS EC2 FPGA Development Kit User Guide](./User_Guide_AWS_EC2_FPGA_Development_Kit.md)
1414

15+
## F2 FPGA ReadTheDocs (Beta)
16+
17+
We are currently migrating our F2 documentation to comply with the ReadTheDocs standard. To familiarize yourself with the new layout, please [click here](https://awsdocs-fpga-f2.readthedocs-hosted.com).
18+
1519
## Support
1620

1721
To raise an issue or receive support, please [open an issue on the official GitHub page](https://github.com/aws/aws-fpga/issues).

‎RELEASE_NOTES.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
# F2 Developer Kit Release Notes
22

3+
## v2.0.1
4+
Updates to HDK, SDK, and Vitis documentation. Added check for XRT install to enable Vitis hardware emulation. XRT install can now be performed automatically by running a command presented during `vitis_setup.sh`.
5+
36
## v2.0.0
4-
Initial release. F2 general-availability companion.
7+
Initial release. F2 general-availability companion.

‎docs-rtd/Makefile

+156
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
# Makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
PAPER =
8+
BUILDDIR = build
9+
10+
# Internal variables.
11+
PAPEROPT_a4 = -D latex_paper_size=a4
12+
PAPEROPT_letter = -D latex_paper_size=letter
13+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
14+
# the i18n builder cannot share the environment and doctrees with the others
15+
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
16+
17+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
18+
19+
help:
20+
@echo "Please use \`make <target>' where <target> is one of"
21+
@echo " html to make standalone HTML files"
22+
@echo " dirhtml to make HTML files named index.html in directories"
23+
@echo " singlehtml to make a single large HTML file"
24+
@echo " pickle to make pickle files"
25+
@echo " json to make JSON files"
26+
@echo " htmlhelp to make HTML files and a HTML help project"
27+
@echo " qthelp to make HTML files and a qthelp project"
28+
@echo " devhelp to make HTML files and a Devhelp project"
29+
@echo " epub to make an epub"
30+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
31+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
32+
@echo " text to make text files"
33+
@echo " man to make manual pages"
34+
@echo " texinfo to make Texinfo files"
35+
@echo " info to make Texinfo files and run them through makeinfo"
36+
@echo " gettext to make PO message catalogs"
37+
@echo " changes to make an overview of all changed/added/deprecated items"
38+
@echo " linkcheck to check all external links for integrity"
39+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
40+
41+
clean:
42+
-rm -rf $(BUILDDIR)/*
43+
44+
html:
45+
$(SPHINXBUILD) -a -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
46+
@echo
47+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
48+
49+
dirhtml:
50+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
51+
@echo
52+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
53+
54+
singlehtml:
55+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
56+
@echo
57+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
58+
59+
pickle:
60+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
61+
@echo
62+
@echo "Build finished; now you can process the pickle files."
63+
64+
json:
65+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
66+
@echo
67+
@echo "Build finished; now you can process the JSON files."
68+
69+
htmlhelp:
70+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
71+
@echo
72+
@echo "Build finished; now you can run HTML Help Workshop with the" \
73+
".hhp project file in $(BUILDDIR)/htmlhelp."
74+
75+
qthelp:
76+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
77+
@echo
78+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
79+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
80+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/F2.qhcp"
81+
@echo "To view the help file:"
82+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/F2.qhc"
83+
84+
devhelp:
85+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
86+
@echo
87+
@echo "Build finished."
88+
@echo "To view the help file:"
89+
@echo "# mkdir -p $$HOME/.local/share/devhelp/F2"
90+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/F2"
91+
@echo "# devhelp"
92+
93+
epub:
94+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
95+
@echo
96+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
97+
98+
latex:
99+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
100+
@echo
101+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
102+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
103+
"(use \`make latexpdf' here to do that automatically)."
104+
105+
latexpdf:
106+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
107+
@echo "Running LaTeX files through pdflatex..."
108+
$(MAKE) -C $(BUILDDIR)/latex all-pdf
109+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
110+
111+
text:
112+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
113+
@echo
114+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
115+
116+
man:
117+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
118+
@echo
119+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
120+
121+
texinfo:
122+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
123+
@echo
124+
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
125+
@echo "Run \`make' in that directory to run these through makeinfo" \
126+
"(use \`make info' here to do that automatically)."
127+
128+
info:
129+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
130+
@echo "Running Texinfo files through makeinfo..."
131+
make -C $(BUILDDIR)/texinfo info
132+
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
133+
134+
gettext:
135+
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
136+
@echo
137+
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
138+
139+
changes:
140+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
141+
@echo
142+
@echo "The overview file is in $(BUILDDIR)/changes."
143+
144+
linkcheck:
145+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
146+
@echo
147+
@echo "Link check complete; look for any errors in the above output " \
148+
"or in $(BUILDDIR)/linkcheck/output.txt."
149+
150+
doctest:
151+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
152+
@echo "Testing of doctests in the sources finished, look at the " \
153+
"results in $(BUILDDIR)/doctest/output.txt."
154+
155+
spelling:
156+
$(SPHINXBUILD) -b spelling source/ build/

‎docs-rtd/requirements.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
sphinx==5.3.0

‎docs-rtd/source/ERRATA.rst

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
F2 Developer Kit Errata
2+
=======================
3+
4+
Shell Errata
5+
------------
6+
7+
Shell errata is `documented here <./hdk/docs/AWS_Shell_ERRATA.md>`__
8+
9+
HDK
10+
---
11+
12+
1. Support for the XDMA Shell in the HDK design flow is not available at this time.
13+
CL builds using the XDMA Shell will result in a build failure.
14+
15+
2. CL simulation might show the following "error" message if the `CL
16+
clock generator <./hdk/docs/AWS_CLK_GEN_spec.md>`__ is contained in
17+
the design. By default, the generator blocks all output clocks
18+
(except for ``o_clk_main_a0``) and asserts all output resets. This
19+
behavior violates the built-in reset check in the `AXI SmartConnect
20+
IP <https://www.xilinx.com/products/intellectual-property/smartconnect.html#overview>`__.
21+
This message can be safely ignored. A Fix for this issue is in
22+
progress.
23+
24+
.. code:: bash
25+
26+
# ** Error: [SmartConnect 500-33] s_sc_aresetn should be asserted for at least 16 cycles of m_sc_aclk. tb.card.fpga.CL.CL_HBM.HBM_PRESENT_EQ_1.AXI_CONVERTER_AXI4_AXI3.cl_axi_sc_1x1_i.smartconnect_0.inst.s00_nodes.s00_aw_node.inst.<protected>.<protected>
27+
28+
3. CL simulation might show the following "error" message. This message
29+
can be safely ignored. A Fix for this issue is in progress.
30+
31+
.. code:: bash
32+
33+
# Initializing memory from data in 'ddr4_ddr_10.mem'.
34+
# Reading data in x8 and bl:8 mode (Change with 'config <4,8,16> <4,8>' in this file).
35+
# 'ddr4_ddr_10.mem' set write data width to x4.
36+
# ERROR: Failed to write data burst length to 16. Only <4,8> are valid.
37+
38+
4. XSIM simulator does not support a cycle-accurate simulation model for
39+
the HBM IP. We’re observing significantly longer simulation times
40+
compared to VCS and Questa simulators. This is caused by the HBM BFM
41+
used in XSIM. Therefore, running HBM simulation using VCS or Questa
42+
is strongly recommended.
43+
44+
5. The following hdk tests are not supported in XSIM currently and will
45+
report not supported warning if ran:
46+
47+
- cl_mem_perf:
48+
49+
- test_dram_dma_4k_crossing
50+
- test_dram_dma
51+
- test_dram_dma_align_addr_4k
52+
- test_dram_dma_single_beat_4k
53+
- test_dram_dma_rnd
54+
55+
- cl_dram_hbm_dma:
56+
57+
- test_dram_dma_4k_crossing
58+
59+
6. Simulation of the `HBM monitor
60+
interface <./hdk/docs/AWS_Shell_Interface_Specification.md/#hbm-monitor-interface>`__
61+
is not supported in this release. The HBM IP always passes
62+
initialization and remains in an operating state for all tests.
63+
Simulation support for the HBM monitor will be added in a future
64+
release.
65+
66+
7. AFIs created based on HDK XDMA shell or Vitis are not supported on F2
67+
instances at this time.
68+
69+
8. The following ddr simulation backdoor test is not working with 64GB memory:
70+
71+
- test_ddr_peek_bdr_walking_ones
72+
73+
SDK
74+
---
75+
76+
Software defined Accelerator Development (Vitis)
77+
------------------------------------------------
78+
79+
1. Only hardware emulation via Vitis 2024.1 is currently supported.
80+
81+
2. Support for Vitis 2024.1 accelerator binary creation and AFI creation is not supported, but will be released at a later time.
82+
83+
3. Support for Vitis software emulation has been deprecated by AMD, therefore, no longer supported.

‎docs-rtd/source/RELEASE_NOTES.rst

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
F2 Developer Kit Release Notes
2+
==============================
3+
4+
.. _v201:
5+
6+
v2.0.1
7+
------
8+
9+
Updates to HDK, SDK, and Vitis documentation.
10+
Added check for XRT install to enable Vitis hardware emulation.
11+
XRT install can now be performed automatically by running a
12+
command presented during `vitis_setup.sh`.
13+
14+
.. _v200:
15+
16+
v2.0.0
17+
------
18+
19+
Initial release. F2 general-availability companion.

0 commit comments

Comments
 (0)