update for 2025.1 release (#99)

* Update from 2024.2 to 2025.1:
-update readmes for 2025.1 release
-update tcl with corrected path and new IPs
-add ps1 scripts for existing sh scripts
-add error message in cpp/hpp files for missing files when opening them
-update assets with the latest job and elf files
-delete the sincos table (excel sheet) and add the formula to the relevant hpp file for Training4

* incorporate comments from PR

* Re-add output_image allocation to fix Buildbot.

* Update README.md

remove not on "known issue on python3" from previous release

* Update README.md

add note of known issues in auto instrumentation

---------

Co-authored-by: Shuran Xu <[email protected]>
Co-authored-by: ManuelSaldana <[email protected]>
Co-authored-by: Jennifer Mah <[email protected]>
Co-authored-by: jennifermah76 <[email protected]>

Author: 4 people

.gitattributes

@@ -1,5 +1,5 @@
 # don't modify line endings of bash scripts
 *.sh          text eol=lf
-*.job filter=lfs diff=lfs merge=lfs -text
-*.zip filter=lfs diff=lfs merge=lfs -text
-*.wic.gz filter=lfs diff=lfs merge=lfs -text
+#*.job filter=lfs diff=lfs merge=lfs -text
+#*.zip filter=lfs diff=lfs merge=lfs -text
+#*.wic.gz filter=lfs diff=lfs merge=lfs -text

Canny_RISCV/bmp.hpp

@@ -59,18 +59,21 @@ struct bmp_header_t {
 
 bmp_pixel_t *read_bmp(const char *filename, bmp_header_t *header) {
     FILE *file = fopen(filename, "rb");
-    if (!file) return NULL;
+    if (!file) {
+        fprintf(stderr, "Error: Could not open input image file '%s'\n", filename);
+        return nullptr;
+    }
 
     // read BMP header and verify width/height
-    if (fread(header, sizeof(bmp_header_t), 1, file) != 1) return NULL;
+    if (fread(header, sizeof(bmp_header_t), 1, file) != 1) return nullptr;
     if (header->offset != sizeof(bmp_header_t) ||
-        header->width != WIDTH || header->height != HEIGHT) return NULL;
+        header->width != WIDTH || header->height != HEIGHT) return nullptr;
 
     // allocate image buffer
     bmp_pixel_t *image = (bmp_pixel_t*)malloc(SIZE * sizeof(bmp_pixel_t));
 
     // read BMP image
-    if (fread(image, sizeof(bmp_pixel_t), SIZE, file) != SIZE) return NULL;
+    if (fread(image, sizeof(bmp_pixel_t), SIZE, file) != SIZE) return nullptr;
 
     fclose(file);
     return image;

README.md

@@ -5,7 +5,25 @@ The homepage for the Microchip HLS integrated development environment is:
  - https://www.microchip.com/en-us/products/fpgas-and-plds/fpga-and-soc-design-tools/smarthls-compiler
 
 You can find the Microchip HLS software user guide here:
- - https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=fpgahls&redirect=true&version=latest 
+ - https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=fpgahls&redirect=true&version=latest
+
+# Note:
+To download the precompiled binaries, go to "Releases" then "Assets" or run the following code
+
+Linux:
+<pre> bash setup.sh </pre>
+
+Windows:
+<pre> ./setup.ps1 </pre>
+
+(**if needed**)
+
+By default, Windows restricts script execution. To allow scripts, right-click the PowerShell icon and select "Run as administrator" then run
+<pre> Set-ExecutionPolicy Unrestricted </pre>
+or set execution policy for current user only
+<pre> Set-ExecutionPolicy Unrestricted -Scope CurrentUser </pre>
+
+
 
 ## Tutorials and Trainings
 Example | Description

Training1/Canny/canny.cpp

@@ -39,15 +39,23 @@ int main() {
 
     // read inputs from file
     input_channel = read_bmp(INPUT_IMAGE, &input_channel_header);
-    if (!input_channel) return 1;
+    if (!input_channel){
+    	printf( "Error: Unable to open the file %s \n",INPUT_IMAGE);
+    	return 1;
+    }
+
     input_channel_sw = input_channel;
 
     golden_output_image = read_bmp(GOLDEN_OUTPUT, &golden_output_image_header);
-    if (!golden_output_image) return 1;
 
     output_image = (bmp_pixel_t*)malloc(SIZE * sizeof(bmp_pixel_t));
     output_image_ptr = output_image;
 
+    if (!golden_output_image){
+    	printf( "Error: Unable to open the file %s \n",GOLDEN_OUTPUT);
+    	return 1;
+    }
+           
     // convert image to grayscale and write to input array
     unsigned char (*input_image)[WIDTH] = new unsigned char[HEIGHT][WIDTH];
     for (i = 0; i < HEIGHT; i++) {

Training1/Canny_FIFO_Switch/canny.cpp

@@ -47,11 +47,18 @@ int main() {
 
     // read inputs from file
     input_channel = read_bmp(INPUT_IMAGE, &input_channel_header);
-    if (!input_channel) return 1;
+    if (!input_channel){
+    	printf( "Error: Unable to open the file %s \n",INPUT_IMAGE);
+    	return 1;
+    }
+
     input_channel_sw = input_channel;
 
     golden_output_image = read_bmp(GOLDEN_OUTPUT, &golden_output_image_header);
-    if (!golden_output_image) return 1;
+    if (!golden_output_image){
+    	printf( "Error: Unable to open the file %s \n",GOLDEN_OUTPUT);
+    	return 1;
+    }
 
     output_image = (bmp_pixel_t*)malloc(SIZE * sizeof(bmp_pixel_t));
     output_image_ptr = output_image;

Training1/Gaussian_FIFO_Pipelined/gaussian_filter.cpp

@@ -109,10 +109,16 @@ int main() {
 
     // read inputs from file
     input_channel = read_bmp(INPUT_IMAGE, &input_channel_header);
-    if (!input_channel) return 1;
+    if (!input_channel){
+    	printf( "Error: Unable to open the file %s \n",INPUT_IMAGE);
+    	return 1;
+    }
 
     golden_output_image = read_bmp(GOLDEN_OUTPUT, &golden_output_image_header);
-    if (!golden_output_image) return 1;
+    if (!golden_output_image) {
+    	printf( "Error: Unable to open the file %s \n",GOLDEN_OUTPUT);
+    	return 1;
+    }
 
     output_image = (bmp_pixel_t*)malloc(SIZE * sizeof(bmp_pixel_t));
     output_image_ptr = output_image;

Training1/Gaussian_Memory_Interface/gaussian_filter.cpp

@@ -68,11 +68,18 @@ int main() {
 
     // read inputs from file
     input_channel = read_bmp(INPUT_IMAGE, &input_channel_header);
-    if (!input_channel) return 1;
+    if (!input_channel){
+    	printf( "Error: Unable to open the file %s \n",INPUT_IMAGE);
+    	return 1;
+    }
+
     input_channel_sw = input_channel;
 
     golden_output_image = read_bmp(GOLDEN_OUTPUT, &golden_output_image_header);
-    if (!golden_output_image) return 1;
+    if (!golden_output_image){
+    	printf( "Error: Unable to open the file %s \n",INPUT_IMAGE);
+    	return 1;
+    }
 
     output_image = (bmp_pixel_t*)malloc(SIZE * sizeof(bmp_pixel_t));
     output_image_ptr = output_image;

Training1/Gaussian_Memory_Interface_Pipelined/gaussian_filter.cpp

@@ -69,11 +69,17 @@ int main() {
 
     // read inputs from file
     input_channel = read_bmp(INPUT_IMAGE, &input_channel_header);
-    if (!input_channel) return 1;
+    if (!input_channel){
+    	printf( "Error: Unable to open the file %s \n",INPUT_IMAGE);
+    	return 1;
+    }
     input_channel_sw = input_channel;
 
     golden_output_image = read_bmp(GOLDEN_OUTPUT, &golden_output_image_header);
-    if (!golden_output_image) return 1;
+    if (!golden_output_image){
+    	printf( "Error: Unable to open the file %s \n",INPUT_IMAGE);
+    	return 1;
+    }
 
     output_image = (bmp_pixel_t*)malloc(SIZE * sizeof(bmp_pixel_t));
     output_image_ptr = output_image;

Training1/Libero/libero_flow.tcl

@@ -25,12 +25,12 @@ set Display_Controller_version 3.1.2
 set HDMI_RX_version 4.2.0
 set HDMI_TX_version 1.0.2
 set PF_TX_PLL_version 2.0.304
-set PF_XCVR_ERM_version 3.1.205
+set PF_XCVR_ERM_version 3.1.206
 set PF_XCVR_REF_CLK_version 1.0.103
 set CORERESET_PF_version 2.2.107
 set CORERXIODBITALIGN_version 2.1.104
-set PF_IOD_GENERIC_RX_version 2.1.110
-set PF_DDR4_version 2.5.111
+set PF_IOD_GENERIC_RX_version 2.1.113
+set PF_DDR4_version 2.5.120
 set PF_SRAM_AHBL_AXI_version 1.2.111
 set mipicsi2rxdecoderPF_version 2.2.5
 set COREAHBTOAPB3_version 3.1.100
@@ -39,7 +39,7 @@ set CoreAPB3_version 4.1.100
 set CoreGPIO_version 3.2.102
 set COREJTAGDEBUG_version 3.1.100
 set CoreAHBLite_version 5.4.102
-set PF_INIT_MONITOR_version 2.0.307
+set PF_INIT_MONITOR_version 2.0.308
 set MIV_RV32IMA_L1_AHB_version 2.3.100
 set COREUART_version 5.6.102
 set Bayer_Interpolation_version 3.0.2

Training1/Libero/run_shls_on_examples.ps1

@@ -5,23 +5,23 @@
 
 Write-Host "Running shls hw on Canny_FIFO_Switch"
 cd ../Canny_FIFO_Switch
-shls hw
+shls -a hw
 
 Write-Host "Running shls hw on Gaussian_FIFO_Pipelined"
 cd ../Gaussian_FIFO_Pipelined
-shls hw
+shls -a hw
 
 Write-Host "Running shls hw on RGB2YCbCr"
 cd ../RGB2YCbCr
-shls hw
+shls -a hw
 
 Write-Host "Running shls hw on YCbCr2RGB"
 cd ../YCbCr2RGB
-shls hw
+shls -a hw
 
 Write-Host "Running shls hw on alpha_blend"
 cd ../alpha_blend
-shls hw
+shls -a hw
 
 cd ../Libero/