From 27f4d0efe5ea9f70cdc516b90c4f2d0ab5e93dbc Mon Sep 17 00:00:00 2001
From: "joachim.schmidt" <joachim.schmidt@hesge.ch>
Date: Wed, 15 Sep 2021 13:33:00 +0200
Subject: [PATCH] Update README.md for scalp router

---
 README.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)

diff --git a/README.md b/README.md
index 763a413..ea7de56 100644
--- a/README.md
+++ b/README.md
@@ -771,6 +771,12 @@ Then checkout the **SCALP-USER-v0.5.1** tag.
 $ git checkout SCALP-USER-v0.5.1
 ```
 
+**For the design with the NoC Scalp :**
+
+```
+$ git checkout SCALP-ROUTER-v0.1
+```
+
 **If you have not gone through the scalp\_safe\_petalinux firmware creation section, please go to section [Copy Scalp board files](#copy-scalp-board-files).**
 
 #### Build the user bitstream file.
@@ -790,6 +796,10 @@ and File -> Export -> Export Hardware -> include bitstream
 
 In my case **\<SCALP_USER_FIRMWARE\>** corresponds to "scalp\_user\_firmware".
 
+**For the design with the NoC Scalp :**
+
+**\<SCALP_USER_FIRMWARE\>** corresponds to "scalp\_router\_firmware".
+
 **If you have not gone through the scalp\_safe\_petalinux firmware creation process, please follow the instructions below to clone the scalp\_petalinux GIT repository.**
 
 **ONLY IF YOU HAVEN'T DONE IT YET.**
@@ -808,6 +818,12 @@ $ git checkout SCALP-USER-v0.5.1
 
 **Use version 0.5.1 for the GIT scalp_petalinux repository and version 0.5.1 for the GIT scalp_firmware repository. Be careful, sometimes the versions are identical, but depending on the evolution of the FPGA firmware and the PetaLinux firmware, the versions may be different.**
 
+**For the design with the NoC Scalp :**
+
+```
+$ git checkout SCALP-ROUTER-v0.1
+```
+
 ### Create a new Scalp User Petalinux project from a BSP
 
 **If you want to name your "scalp_user_firmware" project, please delete the one already present. This folder has been left deliberately.**
@@ -820,6 +836,10 @@ $ cd <PROJECT NAME>
 
 In my case **\<path-to-bsp\>** corresponds to /home/jo/Documents/Projets/Hepia/scalp_project/scalp_petalinux/bsp/SCALP-USER-FIRMWARE-BSP-V0.5.1.bsp
 
+**For the design with the NoC Scalp :**
+
+**\<path-to-bsp\>** corresponds to /home/jo/Documents/Projets/Hepia/scalp_project/scalp_petalinux/bsp/SCALP-ROUTER-FIRMWARE-BSP-V0.1.bsp
+
 ### Importing hardware configuration
 
 **The hardware description of the project must have been exported from Vivado beforehand.**
@@ -832,6 +852,10 @@ $ petalinux-config --get-hw-description=$(find ${SCALP_FIRMWARE_PATH} -name ${SC
 
 In my case **\<PATH_TO_SCALP_FIRMWARE_PROJECT\>** corresponds to /home/jo/Documents/Projets/Hepia/scalp_project/scalp_firmware/ and  **\<SCALP_USER_FIRMWARE\>** corresponds to **scalp_user_firmware**.
 
+**For the design with the NoC Scalp :**
+
+**\<PATH_TO_SCALP_FIRMWARE_PROJECT\>** corresponds to /home/jo/Documents/Projets/Hepia/scalp_project/scalp_firmware/ and  **\<SCALP_USER_FIRMWARE\>** corresponds to **scalp_router_firmware**.
+
 **In the case of user firmware, it is not necessary to configure U-Boot. It is not used.**
 
 ### Added some utilities including Python
@@ -871,12 +895,23 @@ $ cat project-spec/meta-user/recipes-apps/bitstream-conf/files/bitstream-conf |
 > export BITSTREAM_FILE_NAME="scalp_user_firmware.bit.bin"
 ```
 
+**For the design with the NoC Scalp :**
+
+```
+$ cat project-spec/meta-user/recipes-apps/bitstream-conf/files/bitstream-conf | grep "export BITSTREAM_FILE_NAME"
+> export BITSTREAM_FILE_NAME="scalp_router_firmware.bit.bin"
+```
+
 The name of the bitstream file before the .bit.bin extension must be the same as the firmware name defined in the export environment variable SCALP\_USER\_FIRMWARE="\<SCALP\_USER\_FIRMWARE>" described in the section [Importing hardware configuration](#importing-hardware-configuration).
 
 In my case, the environment variable **BITSTREAM\_FILE\_NAME** corresponds to **scalp\_user\_firmware.bit.bin**.
 
 Otherwise, the bitstream configuration file will not be automatically taken into account.
 
+**For the design with the NoC Scalp :**
+
+The environment variable **BITSTREAM\_FILE\_NAME** corresponds to **scalp\_router\_firmware.bit.bin**.
+
 ### Build the PetaLinux project
 
 ```
@@ -902,6 +937,14 @@ $ lsblk              <----- Without the SD card inserted.
 $ sudo dd if=./images/linux/virtualfs-ext4.img of=/dev/\<MMC_DEV_NODE\> status=progress        <----- Beware of danger, be sure.
 ```
 
+or
+
+```
+$ cp ../tools/virtfs.sh images/linux/ && cd images/linux/ && chmod +x virtfs.sh && sudo ./virtfs.sh && cd ../.. && lsblk
+$ lsblk
+$ sudo dd if=./images/linux/virtualfs-ext4.img of=/dev/\<MMC_DEV_NODE\> status=progress
+```
+
 **P.S. We cannot be held responsible if your computer does not start and you have lost all your data that you did not backup. Too bad for you ;D**
 
 **This is the end of the short but dangerous way to your user firmware.**
-- 
GitLab