Merge pull request #672 from aws/rc/2.0.2

Release v2.0.2

Author: mjthimm

ERRATA.md

@@ -26,24 +26,12 @@ Shell errata is [documented here](./hdk/docs/AWS_Shell_ERRATA.md)
 
 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.
 
-5. The following HDK tests are currently not supported in XSIM and will report not supported warning if ran:
+5. 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.
 
-   - cl_mem_perf:
-     - test_dram_dma_4k_crossing
-     - test_dram_dma
-     - test_dram_dma_align_addr_4k
-     - test_dram_dma_single_beat_4k
-     - test_dram_dma_rnd
-
-   - cl_dram_hbm_dma:
-     - test_dram_dma_4k_crossing
-
-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.
-
-7. AFIs created based on HDK XDMA shell or Vitis are not supported on F2
+6. AFIs created based on HDK XDMA shell or Vitis are not supported on F2
    instances at this time.
 
-8. The following ddr simulation backdoor test is not working with 64GB memory:
+7. The following ddr simulation backdoor test is not working with 64GB memory:
    - test_ddr_peek_bdr_walking_ones
 
 ## SDK

RELEASE_NOTES.md

@@ -1,5 +1,8 @@
 # F2 Developer Kit Release Notes
 
+## v2.0.2
+Updates for initial release of ReadTheDocs documentation and to re-enable tests for XSIM.
+
 ## v2.0.1
 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`.
 

docs-rtd/requirements.txt

@@ -1 +1,4 @@
 sphinx==5.3.0
+pyenchant==3.2.2
+termcolor==2.5.0
+sphinxcontrib-spelling==8.0.1

docs-rtd/source/ERRATA.rst

@@ -4,7 +4,7 @@ F2 Developer Kit Errata
 Shell Errata
 ------------
 
-Shell errata is `documented here <./hdk/docs/AWS_Shell_ERRATA.md>`__
+Shell errata is `documented here <./hdk/docs/AWS_Shell_ERRATA.html>`__
 
 HDK
 ---
@@ -13,7 +13,7 @@ HDK
    CL builds using the XDMA Shell will result in a build failure.
 
 2. CL simulation might show the following "error" message if the `CL
-   clock generator <./hdk/docs/AWS_CLK_GEN_spec.md>`__ is contained in
+   clock generator <./hdk/docs/AWS_CLK_GEN_spec.html>`__ 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
@@ -41,32 +41,17 @@ HDK
    used in XSIM. Therefore, running HBM simulation using VCS or Questa
    is strongly recommended.
 
-5. The following hdk tests are not supported in XSIM currently and will
-   report not supported warning if ran:
-
-   - cl_mem_perf:
-
-     - test_dram_dma_4k_crossing
-     - test_dram_dma
-     - test_dram_dma_align_addr_4k
-     - test_dram_dma_single_beat_4k
-     - test_dram_dma_rnd
-
-   - cl_dram_hbm_dma:
-
-     - test_dram_dma_4k_crossing
-
-6. Simulation of the `HBM monitor
-   interface <./hdk/docs/AWS_Shell_Interface_Specification.md/#hbm-monitor-interface>`__
+5. Simulation of the `HBM monitor
+   interface <./hdk/docs/AWS_Shell_Interface_Specification.html#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.
 
-7. AFIs created based on HDK XDMA shell or Vitis are not supported on F2
+6. AFIs created based on HDK XDMA shell or Vitis are not supported on F2
    instances at this time.
 
-8. The following ddr simulation backdoor test is not working with 64GB memory:
+7. The following ddr simulation backdoor test is not working with 64GB memory:
 
    - test_ddr_peek_bdr_walking_ones
 

docs-rtd/source/RELEASE_NOTES.rst

@@ -1,6 +1,12 @@
 F2 Developer Kit Release Notes
 ==============================
 
+.. _v202:
+
+v2.0.2
+------
+Updates for initial release of ReadTheDocs documentation and to re-enable tests for XSIM.
+
 .. _v201:
 
 v2.0.1