| Switches the Renesas config mode. Setting the I2c xfer to 1 will transfer the BRAM contents to the JC |
| measure_frequency | Samples the clocks connected to the frequency monitor and displays their frequencies in Mhz |
**Table 1.** Helper function descriptionsa
## Example Default Usage
If desired, two prebuilt bitstreams (a 1 channel example, and a 4 channel example) are located in the projects 'Example' folder found here. The default scripts assume a 4 channel design is loaded on the FPGA.
Once the design's bitstream has been loaded into the FPGA, use the Tcl console to cd to the folder containing the HwMgr scripts shown in this folder.
In the Tcl Console, type 'source ./runme.tcl' to load the available helper functions. Sourcing this file will automatically preload all the other include Tcl scripts.
Next type 'setup' to reset, initialize and link the 4 GTF channels.
If successful, type 'runme' to do a default transfer. The default runme function will transmit 5 seconds of continuous data and will display a log similar to the following...
```bash
#
# Running Data Stream...
#
Num Channels = 4
Num Cycles = 1
Num Frames/Cycle = 0 (cont.)
Cycle Delay(ms) = 5000
Cycle 1 Channel 0, Packets = 78309826, FIFO Wr Count = 587322522, FIFO RD Count = 587322522, FIFO ERR Count = 0
Cycle 1 Channel 1, Packets = 78309826, FIFO Wr Count = 587322503, FIFO RD Count = 587322503, FIFO ERR Count = 0
Cycle 1 Channel 2, Packets = 78309826, FIFO Wr Count = 587322501, FIFO RD Count = 587322501, FIFO ERR Count = 0
Cycle 1 Channel 3, Packets = 78309826, FIFO Wr Count = 587322507, FIFO RD Count = 587322507, FIFO ERR Count = 0
#
# Complete...
#
```
## Custom Test Runs
As detailed above, the setup and runme functions have default configurations for a 4 channel interface. Using the command line parameter allows the user to generate different test configurations.
Note: Both commands have a '-help' parameter to display the their command line parameters in the Tcl Console.
***"setup" command***
| Parameter | Default Value | Description |
| --- | --- | --- |
| -help | N/A | Displays command usage |
| -n_chan | 4 | Specifies number of channels to initialize |
```bash
Example #1 : Display command line parameters
setup -help
Example #2 : Configure and initialize two channels
setup -n_chan 2
```
***"runme" command***
| Parameter | Default Value | Description |
| --- | --- | --- |
| -help | N/A | Displays command usage |
| -n_chan | 4 | Specifies number of channels to use |
| -n_frames | 0 | If 0, use continuous data transfer until cycle delay time is complete. Otherwise indicates nubmer of packets to transfer |
| -n_cycles | 1 | Specifies number of test iterations (cycles) to run |
| -dekay | 5000 | Specifies delay in ms to run at iteration |
```bash
Example #1 : Display command line parameters
runme -help
Example #2 : Two channels operational with 3 iterations of 10 packets each.
runme -n_chan 2 -n_cycles 3 -n_frames 10
Example #3: Four channels operational (default) with five continuous(default) iterations of 1 minute (60000ms) each.
runme -n_cycles 5 -delay 60000
```
## Support
For additional documentation, please refer to the [UL3524 product page](https://www.xilinx.com/products/boards-and-kits/alveo/ul3524.html) and the [UL3524 Lounge](https://www.xilinx.com/member/ull-ea.html).
For support, contact your FAE or refer to support resources at: https://support.xilinx.com
Copyright © 2020–2023 Advanced Micro Devices, Inc
Terms and Conditions
