Skip to content

Commit 4db2277

Browse files
Ajo E JoseGitHub Enterprise
authored andcommitted
AIE/D/10-GeMM_AIEvsDSP: update the links in README
1 parent df03db6 commit 4db2277

File tree

3 files changed

+24
-28
lines changed

3 files changed

+24
-28
lines changed

AI_Engine_Development/AIE/Design_Tutorials/10-GeMM_AIEvsDSP/AIE/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ $(BUILD_TARGET_DIR)/$(DATAMOVER_KERNEL_XO).xo:
138138
$(DATAMOVER_KERNEL_SRC) -o $@
139139
```
140140

141-
See [this page](https://docs.amd.com/r/en-US/ug1393-vitis-application-acceleration/v-Command) for a detailed description of all Vitis compiler switches. The following table provides a summary of the switches used.
141+
See [this page](https://docs.amd.com/r/en-US/ug1399-vitis-hls/vitis-v-and-vitis-run-Commands) for a detailed description of all Vitis compiler switches. The following table provides a summary of the switches used.
142142

143143
|Switch|Description|
144144
| --- | --- |
@@ -302,7 +302,7 @@ $(BUILD_TARGET_DIR)/$(XSA):$(KERNEL_XOS) $(SYSTEM_CONFIGS_REPO)/*
302302
cd $(BUILD_TARGET_DIR); \
303303
v++ -l $(VPP_FLAGS) $(VPP_LINK_FLAGS) -t $(TARGET) -o $@ $(KERNEL_XOS) $(LIBADF_A)
304304
```
305-
See [this page](https://docs.amd.com/r/en-US/ug1393-vitis-application-acceleration/Building-the-Device-Binary) for a detailed description of Vitis linking options.
305+
See [this page](https://docs.amd.com/r/en-US/ug1701-vitis-accelerated-embedded/Linking-the-System) for a detailed description of Vitis linking options.
306306

307307
|Switch|Description|
308308
| --- | --- |
@@ -312,8 +312,8 @@ See [this page](https://docs.amd.com/r/en-US/ug1393-vitis-application-accelerati
312312
|--verbose|Display verbose/debug information.|
313313
|--config <config_file>|Specifies a configuration file containing V++ switches.|
314314
|--output \| -o|Specifies the name of the output file generated by the V++ command. In this design the outputs of the DMA HLS kernels and the PL kernels interfacing with the AI Engine are in XO files.|
315-
|--profile.data [<kernel_name>\|all]:[<cu_name>\|all]:[<interface_name>\|all]\(:[counters\|all]\)|Enables monitoring of data ports through the monitor IPs. This option needs to be specified during linking. See [this page](https://docs.amd.com/r/en-US/ug1393-vitis-application-acceleration/profile-Options) for detailed profiling options.|
316-
|--profile.trace_memory \<FIFO\>:\<size\>\|\<MEMORY\>[\<n\>]|When building the hardware target \(-t=hw\), use this option to specify the type and amount of memory to use for capturing trace data. See [this page](https://docs.amd.com/r/en-US/ug1393-vitis-application-acceleration/profile-Options) for detailed profiling options.|
315+
|--profile.data [<kernel_name>\|all]:[<cu_name>\|all]:[<interface_name>\|all]\(:[counters\|all]\)|Enables monitoring of data ports through the monitor IPs. This option needs to be specified during linking. See [this page](https://docs.amd.com/r/en-US/ug1702-vitis-accelerated-reference/profile-Options) for detailed profiling options.|
316+
|--profile.trace_memory \<FIFO\>:\<size\>\|\<MEMORY\>[\<n\>]|When building the hardware target \(-t=hw\), use this option to specify the type and amount of memory to use for capturing trace data. See [this page](https://docs.amd.com/r/en-US/ug1702-vitis-accelerated-reference/profile-Options) for detailed profiling options.|
317317

318318
The information to tell the linker how to connect the AI Engine and PL kernels together is described in a configuration file, `system_configs/x$(GEMM_INSTS).cfg`. The file describes the overall connection scheme of the system.
319319

@@ -369,7 +369,7 @@ param=hw_emu.enableProfiling=false
369369
370370
```
371371

372-
See [this page](https://docs.amd.com/r/en-US/ug1393-vitis-application-acceleration/Vitis-Compiler-Configuration-File) for a detailed description of the Vitis compiler configuration file.
372+
See [this page](https://docs.amd.com/r/en-US/ug1702-vitis-accelerated-reference/Vitis-Compiler-Configuration-File) for a detailed description of the Vitis compiler configuration file.
373373

374374
|Switch|Comment|
375375
| --- | --- |
@@ -495,14 +495,14 @@ $(EMBEDDED_PACKAGE_OUT): $(PROFILING_CONFIGS_REPO)/* $(EXEC_SCRIPTS_REPO)/* $(BU
495495
v++ -p $(PKG_FLAGS)
496496
```
497497

498-
See [this page](https://docs.amd.com/r/en-US/ug1393-vitis-application-acceleration/package-Options) for more details about packaging the system.
498+
See [this page](https://docs.amd.com/r/en-US/ug1702-vitis-accelerated-reference/Package-Options) for more details about packaging the system.
499499

500500
|Switch|Description|
501501
| --- | --- |
502502
|--target \| -t [hw\|hw_emu]|Specifies the build target.|
503503
|--package \| -p|Packages the final product at the end of the Vitis compile and link build process.|
504-
|--package.rootfs \<arg\>|Where \<arg\> specifies the absolute or relative path to a processed Linux root file system file. The platform RootFS file is available for download from xilinx.com. Refer to the [Vitis Software Platform Installation](https://docs.amd.com/r/en-US/ug1393-vitis-application-acceleration/Vitis-Software-Platform-Installation) for more information.|
505-
|--package.kernel_image \<arg\>|Where \<arg\> specifies the absolute or relative path to a Linux kernel image file. Overrides the existing image available in the platform. The platform image file is available for download from xilinx.com. Refer to the [Vitis Software Platform Installation](https://docs.amd.com/r/en-US/ug1393-vitis-application-acceleration/Vitis-Software-Platform-Installation) for more information.|
504+
|--package.rootfs \<arg\>|Where \<arg\> specifies the absolute or relative path to a processed Linux root file system file. The platform RootFS file is available for download from xilinx.com. Refer to the [Vitis Software Platform Installation](https://docs.amd.com/r/en-US/ug1701-vitis-accelerated-embedded/Vitis-Software-Platform-Installation) for more information.|
505+
|--package.kernel_image \<arg\>|Where \<arg\> specifies the absolute or relative path to a Linux kernel image file. Overrides the existing image available in the platform. The platform image file is available for download from xilinx.com. Refer to the [Vitis Software Platform Installation](https://docs.amd.com/r/en-US/ug1701-vitis-accelerated-embedded/Vitis-Software-Platform-Installation) for more information.|
506506
|--package.boot_mode \<arg\>|Where \<arg\> specifies <ospi\|qspi\|sd>. Boot mode used for running the application in emulation or on hardware.|
507507
|--package.image_format|Where \<arg\> specifies the \<ext4\|fat32\> output image file format. `ext4` is the Linux file system and `fat32` is the Windows file system.|
508508
|--package.sd_file|Where \<arg\> specifies an ELF or other data file to package into the `sd_card` directory/image. This option can be used repeatedly to specify multiple files to add to the `sd_card` directory.|
@@ -1400,7 +1400,7 @@ Throughput is measured in mega-samples transferred per second (MSPS). Latency is
14001400
trace_buffer_size=8M
14011401
```
14021402

1403-
Refer to the [xrt.ini](https://docs.amd.com/r/en-US/ug1393-vitis-application-acceleration/xrt.ini-File) documentation for more information.
1403+
Refer to the [xrt.ini](https://docs.amd.com/r/en-US/ug1702-vitis-accelerated-reference/xrt.ini-File) documentation for more information.
14041404

14051405
2. After execution on the board, transfer the generated `device_trace_0.csv`, `hal_host_trace.csv`, and `xrt.run_summary` files back to your system.
14061406

AI_Engine_Development/AIE/Design_Tutorials/10-GeMM_AIEvsDSP/DSP/README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ The generated files are placed under an individual directory: `$(BUILD_TARGET_DI
9797

9898
<details>
9999

100-
See [this page](https://docs.amd.com/r/en-US/ug1393-vitis-application-acceleration/v-Command) for a detailed description of all Vitis compiler switches. The following table provides a summary of the switches used.
100+
See [this page](https://docs.amd.com/r/en-US/ug1399-vitis-hls/vitis-v-and-vitis-run-Commands) for a detailed description of all Vitis compiler switches. The following table provides a summary of the switches used.
101101

102102

103103
|Switch|Description|
@@ -188,7 +188,7 @@ v++ -l --platform xilinx_vck190_base_202420_1 --save-temps --temp_dir $(BUILD_TA
188188
-t hw_emu -o $(BUILD_TARGET_DIR)/gemm.hw_emu.xclbin $(PROJECT_REPO)/build/gemm_GEMM_SIZExGEMM_SIZExGEMM_SIZE/gemm_large_ocm.xo
189189
```
190190

191-
See [this page](https://docs.amd.com/r/en-US/ug1393-vitis-application-acceleration/Building-the-Device-Binary) for a detailed description of Vitis linking options. The following table provides a summary of the switches used.
191+
See [this page](https://docs.amd.com/r/en-US/ug1701-vitis-accelerated-embedded/Linking-the-System) for a detailed description of Vitis linking options. The following table provides a summary of the switches used.
192192

193193
|Switch|Description|
194194
| --- | --- |
@@ -197,9 +197,9 @@ See [this page](https://docs.amd.com/r/en-US/ug1393-vitis-application-accelerati
197197
|--temp_dir <string>|This allows you to manage the location where the tool writes temporary files created during the build process. The temporary results are written by the Vitis compiler, and then removed, unless the `--save-temps` option is also specified.|
198198
|--verbose|Display verbose/debug information.|
199199
|--output \| -o|Specifies the name of the output file generated by the V++ command. In this design the outputs of the HLS/DSP kernels with their interfacing with the PL kernels are in XO files.|
200-
|--vivado.prop \<arg\>|Specifies properties for the Vivado Design Suite to be used during synthesis and implementation of the FPGA binary (xclbin). See [this page](https://docs.amd.com/r/en-US/ug1393-vitis-application-acceleration/vivado-Options) for detailed Vivado options.|
201-
|--profile.data [<kernel_name>\|all]:[<cu_name>\|all]:[<interface_name>\|all]\(:[counters\|all]\)|Enables monitoring of data ports through the monitor IPs. This option needs to be specified during linking. See [this page](https://docs.amd.com/r/en-US/ug1393-vitis-application-acceleration/profile-Options) for detailed profiling options.|
202-
|--profile.trace_memory \<FIFO\>:\<size\>\|\<MEMORY\>[\<n\>]|When building the hardware target \(-t=hw\), use this option to specify the type and amount of memory to use for capturing trace data. See [this page](https://docs.amd.com/r/en-US/ug1393-vitis-application-acceleration/profile-Options) for detailed profiling options.|
200+
|--vivado.prop \<arg\>|Specifies properties for the Vivado Design Suite to be used during synthesis and implementation of the FPGA binary (xclbin). See [this page](https://docs.amd.com/r/en-US/ug1702-vitis-accelerated-reference/vivado-Options) for detailed Vivado options.|
201+
|--profile.data [<kernel_name>\|all]:[<cu_name>\|all]:[<interface_name>\|all]\(:[counters\|all]\)|Enables monitoring of data ports through the monitor IPs. This option needs to be specified during linking. See [this page](https://docs.amd.com/r/en-US/ug1701-vitis-accelerated-embedded/Profiling-the-Application) for detailed profiling options.|
202+
|--profile.trace_memory \<FIFO\>:\<size\>\|\<MEMORY\>[\<n\>]|When building the hardware target \(-t=hw\), use this option to specify the type and amount of memory to use for capturing trace data. See [this page](https://docs.amd.com/r/en-US/ug1701-vitis-accelerated-embedded/Profiling-the-Application) for detailed profiling options.|
203203
|--config <config_file>|Specifies a configuration file containing V++ switches.|
204204

205205
The information to tell the linker how to connect the PL kernels together is described in a configuration file, `system_configs/gemm.cfg`. The file describes the overall connection scheme of the system.
@@ -209,7 +209,7 @@ The information to tell the linker how to connect the PL kernels together is des
209209
nk=gemm_large_ocm:1:gemm_large_ocm_0
210210
211211
[clock]
212-
id=0:gemm_large_ocm_0.S_AXI_ACLK
212+
#id=0:gemm_large_ocm_0.S_AXI_ACLK
213213
214214
[advanced]
215215
## Disable Profiling in hw_emu so that it is faster...
@@ -221,14 +221,16 @@ param=compiler.worstNegativeSlack=-1.0
221221
prop=run.synth_1.STRATEGY=Flow_PerfOptimized_high
222222
prop=run.impl_1.STEPS.OPT_DESIGN.is_enabled=true
223223
prop=run.impl_1.STEPS.OPT_DESIGN.ARGS.DIRECTIVE=Explore
224-
prop=run.impl_1.STEPS.PLACE_DESIGN.ARGS.DIRECTIVE=ExtraTimingOpt
224+
#prop=run.impl_1.STEPS.PLACE_DESIGN.ARGS.DIRECTIVE=ExtraTimingOpt
225+
prop=run.impl_1.STEPS.PLACE_DESIGN.ARGS.DIRECTIVE=Explore
226+
225227
prop=run.impl_1.STEPS.PHYS_OPT_DESIGN.is_enabled=true
226228
prop=run.impl_1.STEPS.PHYS_OPT_DESIGN.ARGS.DIRECTIVE=AggressiveExplore
227229
#prop=run.impl_1.STEPS.ROUTE_DESIGN.ARGS.MORE OPTIONS=-tns_cleanup
228230
prop=run.impl_1.STEPS.ROUTE_DESIGN.ARGS.DIRECTIVE=AggressiveExplore
229231
```
230232

231-
See [this page](https://docs.amd.com/r/en-US/ug1393-vitis-application-acceleration/Vitis-Compiler-Configuration-File) for a detailed description of the Vitis compiler configuration file. A summary of the configuration options used is provided in the following table.
233+
See [this page](https://docs.amd.com/r/en-US/ug1702-vitis-accelerated-reference/Vitis-Compiler-Configuration-File) for a detailed description of the Vitis compiler configuration file. A summary of the configuration options used is provided in the following table.
232234

233235

234236
|Switch|Comment|
@@ -343,15 +345,15 @@ If the `XRT_ROOT` is set, the following Vitis compiler flags are also set:
343345
--package.sd_dir $(XRT_ROOT)
344346
```
345347

346-
See [this page](https://docs.amd.com/r/en-US/ug1393-vitis-application-acceleration/package-Options) for more details about packaging the system.
348+
See [this page](https://docs.amd.com/r/en-US/ug1702-vitis-accelerated-reference/Package-Options) for more details about packaging the system.
347349

348350

349351
|Switch|Description|
350352
| --- | --- |
351353
|--target \| -t [hw\|hw_emu]|Specifies the build target.|
352354
|--package \| -p|Packages the final product at the end of the Vitis compile and link build process.|
353-
|--package.rootfs \<arg\>|Where \<arg\> specifies the absolute or relative path to a processed Linux root file system file. The platform RootFS file is available for download from xilinx.com. Refer to the [Vitis Software Platform Installation](https://docs.amd.com/r/en-US/ug1393-vitis-application-acceleration/Vitis-Software-Platform-Installation) for more information.|
354-
|--package.kernel_image \<arg\>|Where \<arg\> specifies the absolute or relative path to a Linux kernel image file. Overrides the existing image available in the platform. The platform image file is available for download from xilinx.com. Refer to the [Vitis Software Platform Installation](https://docs.amd.com/r/en-US/ug1393-vitis-application-acceleration/Vitis-Software-Platform-Installation) for more information.|
355+
|--package.rootfs \<arg\>|Where \<arg\> specifies the absolute or relative path to a processed Linux root file system file. The platform RootFS file is available for download from xilinx.com. Refer to the [Vitis Software Platform Installation](https://docs.amd.com/r/en-US/ug1701-vitis-accelerated-embedded/Vitis-Software-Platform-Installation) for more information.|
356+
|--package.kernel_image \<arg\>|Where \<arg\> specifies the absolute or relative path to a Linux kernel image file. Overrides the existing image available in the platform. The platform image file is available for download from xilinx.com. Refer to the [Vitis Software Platform Installation](https://docs.amd.com/r/en-US/ug1701-vitis-accelerated-embedded/Vitis-Software-Platform-Installation) for more information.|
355357
|--package.boot_mode \<arg\>|Where \<arg\> specifies <ospi\|qspi\|sd> Boot mode used for running the application in emulation or on hardware.|
356358
|--package.image_format|Where \<arg\> specifies \<ext4\|fat32\> output image file format. `ext4` is the Linux file system and `fat32` is the Windows file system.|
357359
|--package.sd_file|Where \<arg\> specifies an ELF or other data file to package into the `sd_card` directory/image. This option can be used repeatedly to specify multiple files to add to the `sd_card`.|

AI_Engine_Development/AIE/Design_Tutorials/10-GeMM_AIEvsDSP/README.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -138,28 +138,22 @@ GeMM_AIEvsDSP
138138

139139
### Installing the Tools
140140

141-
* [AI Engine Tools Lounge](https://www.xilinx.com/member/versal_ai_tools_ea.html)
142141

143142
* [AI Engine Documentation](https://www.xilinx.com/products/design-tools/vitis/vitis-ai.html)
144143

145144
To build and run the GeMM tutorial (AI Engine and HLS implementations), perform the following steps:
146145

147-
* Install the [Vitis Software Platform](https://www.xilinx.com/products/design-tools/vitis/vitis-platform.html).
148146

149147
* Obtain licenses for AI Engine tools.
150148

151-
* Follow the instructions in [Installing Xilinx Runtime and Platforms](https://docs.amd.com/r/en-US/ug1393-vitis-application-acceleration/Installing-Xilinx-Runtime-and-Platforms) (XRT).
152-
153-
* Download and set up the [VCK190 Vitis Platform]( https://www.xilinx.com/support/download/index.html/content/xilinx/en/downloadNav/embedded-platforms.html).
154-
155149
</details>
156150

157151
<details>
158152
<summary>Platform</summary>
159153

160154
### Platform
161155

162-
Before beginning the tutorial, make sure you have read and followed the [Vitis Software Platform Release Notes (v2024.2)](https://docs.amd.com/r/en-US/ug1393-vitis-application-acceleration/Vitis-Software-Platform-Release-Notes) for setting up software and installing the VCK190 base platform.
156+
163157

164158
This tutorial targets the [VCK190 production board](https://www.xilinx.com/products/boards-and-kits/vck190.html). If you have already purchased this board, download the necessary files from the lounge and ensure you have the correct licenses installed. If you do not have a board and the required license, contact your AMD sales team.
165159

@@ -286,7 +280,7 @@ Below are links to the XRT information used by this tutorial:
286280

287281
Below are links to Vitis related information referenced in this tutorial:
288282

289-
* [Vitis Application Acceleration Development Flow Documentation](https://docs.amd.com/r/en-US/ug1393-vitis-application-acceleration)
283+
* [Vitis Application Acceleration Development Flow Documentation](https://docs.amd.com/r/en-US/ug1702-vitis-accelerated-reference)
290284

291285
* [Vitis Application Acceleration Development Flow Tutorials](https://github.com/Xilinx/Vitis-Tutorials)
292286

0 commit comments

Comments
 (0)