Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
programmable-logic:eclypse-z7:environment-setup [2021/11/02 22:08] – Arthur Brownprogrammable-logic:eclypse-z7:environment-setup [2022/10/04 11:38] (current) – external edit 127.0.0.1
Line 3: Line 3:
 /* nosemantic helps avoid this page being listed on google */ /* nosemantic helps avoid this page being listed on google */
  
-This section contains the steps for setting the environment for [[#baremetal_project_setup|setting up Baremetal projects]] and [[#linux_environment_project_setup | Linux project setup]] for both Zmod Scope and Zmod AWG. +This section contains the steps for setting the environment for [[#baremetal_project_setup|setting up Baremetal projects]] and [[#linux_environment_project_setup|setting up Linux projects]] for both Zmod Scope and Zmod AWG. 
-Depending on the user needs, one can either use the projects we deliver in their own development process or use the libraries in their projects. If the second case is considered, the user should apply the below described settings to his project, in order to be able to build it.+Depending on the user's needs, one can either use the projects we deliver in their own development process or use the libraries in their projects. If the second case is considered, the user should apply the described settings below to their project, in order to be able to build it.
  
-==== 1. Import Library and Demo Projects ====+==== Import Library and Demo Projects ====
  
 The steps below need to be followed in order to obtain a complete SDK workspace and to be able to build and run any of the projects, in either Linux or Baremetal platforms. The steps below need to be followed in order to obtain a complete SDK workspace and to be able to build and run any of the projects, in either Linux or Baremetal platforms.
-=== 1.1. Linux Environment Project Setup ===+=== Linux Environment Project Setup ===
  
 /* For the Linux project demo, the operating system of the PC must be a Linux distribution with Xilinx Vivado 2019.1 installed. \\ */ /* For the Linux project demo, the operating system of the PC must be a Linux distribution with Xilinx Vivado 2019.1 installed. \\ */
 The ZmodADC1410_Demo_Linux and ZmodDAC1411_Demo_Linux are run from Xilinx SDK.\\ The ZmodADC1410_Demo_Linux and ZmodDAC1411_Demo_Linux are run from Xilinx SDK.\\
-This step by step tutorial roughly follows the [[https://xilinx-wiki.atlassian.net/wiki/spaces/A/pages/18841623/How+to+debug+Linux+Application+in+SDK+2019.1|How to debug Linux Application in SDK 2019.1]] by Xilinx, with some changes due to our Debian 10 rootfs. \\+This step-by-step tutorial roughly follows the [[https://xilinx-wiki.atlassian.net/wiki/spaces/A/pages/18841623/How+to+debug+Linux+Application+in+SDK+2019.1|How to debug Linux Application in SDK 2019.1]] by Xilinx, with some changes due to our Debian 10 rootfs. \\
  
 <WRAP center round important 80%> <WRAP center round important 80%>
Line 19: Line 19:
 If a Zmod Scope is used, it should be attached to the Eclypse Z7's ZMOD A port. If a Zmod AWG is used, it should be attached to the Eclypse Z7's ZMOD B port. If a Zmod Scope is used, it should be attached to the Eclypse Z7's ZMOD A port. If a Zmod AWG is used, it should be attached to the Eclypse Z7's ZMOD B port.
 </WRAP> </WRAP>
 +
 <WRAP GROUP> <WRAP COLUMN HALF> <WRAP GROUP> <WRAP COLUMN HALF>
-**1.1.1. Download the Library**+**1. Download the Source Code**
   * Download the git repository containing the libraries and demos using the below command:   * Download the git repository containing the libraries and demos using the below command:
  
 <code>git clone --recursive https://github.com/Digilent/Eclypse-Z7-SW.git -b zmod_adc_dac/master</code> <code>git clone --recursive https://github.com/Digilent/Eclypse-Z7-SW.git -b zmod_adc_dac/master</code>
-  
-NOTE: If you choose to download the repository as ZIP, the folder **zmodlib** will not be populated and you will have to populate it manually. 
  
-  * The [[#delivery_structure|delivery structure]] will be later used for the Xilinx SDK workspace.+The directory created when you run this command ("Eclypse-Z7-SW"), will be used as the Xilinx SDK workspace in later steps. 
 + 
 +**Note:** //If you choose to download the repository as ZIP, the folder// zmodlib //will not be populated and you will have to populate it manually.// 
 + 
 +If you want to download the Vivado and PetaLinux projects at the same time, instead clone the ''Eclypse-Z7'' repository (still using the ''zmod_adc_dac/master'' branch). Instructions on working with these projects, as well as on how to check them out from source, can be found in the [[git#vivado_hw_repositories]] documentation.
  
 </WRAP> <WRAP COLUMN HALF> </WRAP> <WRAP COLUMN HALF>
Line 33: Line 36:
 </WRAP></WRAP> </WRAP></WRAP>
  
-**1.1.2. Download the SD Card Image**+**2. Download the SD Card Image**
  
     *  Download the latest eclypse-debian-buster-armhf-rfs.img_X.X.zip Petalinux image from the Eclypse Z7 git repository [[https://github.com/Digilent/Eclypse-Z7/releases|Releases]] and extract it on your PC.     *  Download the latest eclypse-debian-buster-armhf-rfs.img_X.X.zip Petalinux image from the Eclypse Z7 git repository [[https://github.com/Digilent/Eclypse-Z7/releases|Releases]] and extract it on your PC.
Line 48: Line 51:
  
 <WRAP GROUP> <WRAP COLUMN HALF> <WRAP GROUP> <WRAP COLUMN HALF>
-**1.1.3. Add Xilinx SDK Workspace Location**+**3. Select Xilinx SDK Workspace Location**
  
-  * The downloaded workspace contains demo applications for both Linux and Baremetal. +  * The downloaded workspace contains demo applications for both Linux and Baremetal and is intended to be used in place. 
   * Open Xilinx SDK 2019.1 and assign the workspace location to the project download location.   * Open Xilinx SDK 2019.1 and assign the workspace location to the project download location.
-  * If you want to use the demo projects, open the desired Linux or Baremetal demo project. The projects are already configured and ready to be used, except the Linux project where SYSROOT environment variable must be set according to [[#add_sysroot_environment_variable_in_sdk | Add SYSROOT Environment Variable]] section.+  * If you want to use the demo projects, open the desired Linux or Baremetal demo project. The projects are already configured and ready to be used, except the Linux project where SYSROOT environment variable must be set according to the //Add SYSROOT Environment Variable// section (step 1.5, below).
  
 </WRAP> <WRAP COLUMN HALF> </WRAP> <WRAP COLUMN HALF>
Line 61: Line 64:
  
 <WRAP GROUP> <WRAP COLUMN HALF> <WRAP GROUP> <WRAP COLUMN HALF>
-**1.1.4. Import Library to Xilinx SDK**+**4. Import Projects to Xilinx SDK**
     * File -> Import     * File -> Import
 </WRAP> <WRAP COLUMN HALF> </WRAP> <WRAP COLUMN HALF>
Line 82: Line 85:
  
 <WRAP GROUP> <WRAP COLUMN HALF> <WRAP GROUP> <WRAP COLUMN HALF>
-**1.1.5. Add SYSROOT Environment Variable in SDK**+**5. Add SYSROOT Environment Variable in SDK**
  
   *  Download the latest eclypse-debian-buster-armhf-sysroot_X.X.tar.xz (**.zip** for Windows ) sysroot from the Eclypse Z7 git repository's [[https://github.com/Digilent/Eclypse-Z7/releases|Releases]] page and extract it on your PC (the location of the extracted folder will be later used as the path for the SYSROOT Environment Variable) \\ **Note:** //You need to expand the Assets section from github to see the eclypse-debian-buster-armhf-sysroot_X.X.tar.xz and .zip files.// \\ **Windows only:** //When prompted whether to replace existing files, choose to replace.//   *  Download the latest eclypse-debian-buster-armhf-sysroot_X.X.tar.xz (**.zip** for Windows ) sysroot from the Eclypse Z7 git repository's [[https://github.com/Digilent/Eclypse-Z7/releases|Releases]] page and extract it on your PC (the location of the extracted folder will be later used as the path for the SYSROOT Environment Variable) \\ **Note:** //You need to expand the Assets section from github to see the eclypse-debian-buster-armhf-sysroot_X.X.tar.xz and .zip files.// \\ **Windows only:** //When prompted whether to replace existing files, choose to replace.//
-  * In the SDK Project Explorer, right click on the application project you wish to run, then click “C/C++ Build Settings”+  * In the SDK Project Explorer, right-click on the application project you wish to run, then click “C/C++ Build Settings”
   * In the “C/C++ Build” group, select the “Environment” category   * In the “C/C++ Build” group, select the “Environment” category
   * Add the SYSROOT variable pointing to the location where eclypse-debian-buster-armhf-sysroot rootfs folder can be found. For example “/home/cosmin/Documents/eclypse-debian-buster-armhf-sysroot” \\ **Windows:** //The SYSROOT environment variable if exists must be //Delete//d then re//Add//ed to the list, rather than //Edit//ing the existing variable.//   * Add the SYSROOT variable pointing to the location where eclypse-debian-buster-armhf-sysroot rootfs folder can be found. For example “/home/cosmin/Documents/eclypse-debian-buster-armhf-sysroot” \\ **Windows:** //The SYSROOT environment variable if exists must be //Delete//d then re//Add//ed to the list, rather than //Edit//ing the existing variable.//
Line 97: Line 100:
  
 <WRAP GROUP> <WRAP COLUMN HALF> <WRAP GROUP> <WRAP COLUMN HALF>
-**1.1.6. Find the Board IP Address**+**6. Find the Board IP Address**
   * In the UART Terminal connected to the board, log in with the username/password combination eclypse/eclypse    * In the UART Terminal connected to the board, log in with the username/password combination eclypse/eclypse 
   * Run the following command:   * Run the following command:
Line 109: Line 112:
 ---- ----
 <WRAP GROUP> <WRAP COLUMN HALF> <WRAP GROUP> <WRAP COLUMN HALF>
-**1.1.7. Establishing Connection to the Board**+**7. Establishing Connection to the Board**
   * In the SDK Target Connections panel, open the Linux TCF Agent folder   * In the SDK Target Connections panel, open the Linux TCF Agent folder
-  * Right click on Linux Agent [default] and click Edit+  * Right-click on Linux Agent [default] and click Edit
   * Enter the board IP address into the Host section   * Enter the board IP address into the Host section
   * Click Test Connection to make sure that SDK can communicate with the TCF-agent on the board   * Click Test Connection to make sure that SDK can communicate with the TCF-agent on the board
Line 122: Line 125:
 ---- ----
 <WRAP GROUP> <WRAP COLUMN HALF> <WRAP GROUP> <WRAP COLUMN HALF>
-**1.1.8. Run the Demo Project**+**8. Run the Demo Project**
  
 To run the demo application, right-click on Project name -> Run as -> Launch on Hardware(System Debugger) To run the demo application, right-click on Project name -> Run as -> Launch on Hardware(System Debugger)
Line 130: Line 133:
 ---- ----
  
-=== 1.2. Baremetal Project Setup ===+=== Baremetal Project Setup ===
 <WRAP GROUP> <WRAP COLUMN HALF> <WRAP GROUP> <WRAP COLUMN HALF>
-**1.2.1. Download the Library**+**1. Download the Source Code**
  
 Download the demo project with the below command: Download the demo project with the below command:
Line 138: Line 141:
 <code>git clone --recursive https://github.com/Digilent/Eclypse-Z7-SW.git -b zmod_adc_dac/master</code> <code>git clone --recursive https://github.com/Digilent/Eclypse-Z7-SW.git -b zmod_adc_dac/master</code>
    
-NOTE: If you choose to download the repository as ZIP, the folder **zmodlib** will not be populated and you will have to populate it manually.+The directory created when you run this command ("Eclypse-Z7-SW"), will be used as the Xilinx SDK workspace in later steps.
  
-The [[#delivery_structure|delivery structure]] will be later used for the Xilinx SDK workspace.+**Note:** //If you choose to download the repository as ZIP, the folder// zmodlib //will not be populated and you will have to populate it manually.// 
 + 
 +If you want to download the Vivado and PetaLinux projects at the same time, instead clone the ''Eclypse-Z7'' repository (still using the ''zmod_adc_dac/master'' branch). Instructions on working with these projects, as well as on how to check them out from source, can be found in the [[git#vivado_hw_repositories]] documentation.
  
 </WRAP> <WRAP COLUMN HALF> </WRAP> <WRAP COLUMN HALF>
Line 148: Line 153:
 ---- ----
 <WRAP GROUP> <WRAP COLUMN HALF> <WRAP GROUP> <WRAP COLUMN HALF>
-**1.2.2. Add Xilinx SDK Workspace Location**+**2. Add Xilinx SDK Workspace Location**
  
   * The downloaded workspace contains demo applications for both Linux and Baremetal.    * The downloaded workspace contains demo applications for both Linux and Baremetal. 
Line 160: Line 165:
 ---- ----
 <WRAP GROUP> <WRAP COLUMN HALF> <WRAP GROUP> <WRAP COLUMN HALF>
-**1.2.3. Import Library to Xilinx SDK**+**3. Import Library to Xilinx SDK**
   * File -> Import   * File -> Import
  
Line 181: Line 186:
 ---- ----
 <WRAP GROUP> <WRAP COLUMN HALF> <WRAP GROUP> <WRAP COLUMN HALF>
-**1.2.4. Xilinx SDK Project Explorer**+**4. Xilinx SDK Project Explorer**
  
   *  The ZmodADC1410_Demo_Linux and ZmodDAC1411_Demo_Linux projects must be closed or deleted from Project Explorer (right-click on project name-> Close Project or Delete)   *  The ZmodADC1410_Demo_Linux and ZmodDAC1411_Demo_Linux projects must be closed or deleted from Project Explorer (right-click on project name-> Close Project or Delete)
Line 191: Line 196:
  
 <WRAP GROUP> <WRAP COLUMN HALF> <WRAP GROUP> <WRAP COLUMN HALF>
-**1.2.5. Run the Demo Project**+**5. Run the Demo Project**
   * Make sure the board is connected to your PC and it is powered on.   * Make sure the board is connected to your PC and it is powered on.
   * Make sure the jumpers are set accordingly.   * Make sure the jumpers are set accordingly.
Line 203: Line 208:
 {{ :reference:zmod:capture8.png?450 |}} {{ :reference:zmod:capture8.png?450 |}}
 </WRAP> </WRAP> </WRAP> </WRAP>
- 
----- 
- 
-==== 2. Create New Project or Use Libraries in your project ==== 
- 
-These steps are required when an SDK workspace is first opened by the user. 
-The steps below need to be followed in order to obtain a complete SDK workspace and to be able to build and run any of the projects, in either Linux or Baremetal platforms. 
- 
-=== 2.1. Linux Environment Project Setup === 
-       
-**2.1.1. Create New Project and Link zmodlib Folder** 
- 
-<WRAP GROUP> <WRAP COLUMN HALF>     
-  It is assumed that Zmod and specific folders for Zmods (ZmodADC1410 for example) are placed in the SDK workspace root folder, as provided by Digilent (see [[#delivery_structure|Delivery Structure]]). 
-  * Create a new application project. 
-  * Under src folder, right click option, select New / Folder 
-  * Select Advanced 
-  * Link to alternate location (Linked Folder) 
-  * **Variables...** -> Select **WORKSPACE_LOC** -> Extend... -> Select **zmodlib** folder 
-</WRAP> <WRAP COLUMN HALF> 
-{{ :reference:zmod:capture4.2.1.png|}} 
-</WRAP></WRAP> 
- 
-<WRAP GROUP> <WRAP COLUMN HALF> 
-**2.1.2. Add “--sysroot” Project Setting** 
- 
-  * In the Project Explorer, right click on the project name, select “C/C++ Build Settings” 
-  * In the “C/C++ Build” group, select “Settings” category 
-  * Select “ARM v7 Linux g++ linker”/”Miscelaneous” node 
-  * In the Linker Flags field add <code>--sysroot=${SYSROOT}</code> 
- 
-</WRAP> <WRAP COLUMN HALF> 
-{{ :reference:zmod:capture4.1.6.png |}} 
-</WRAP> </WRAP>  
- 
-<WRAP GROUP> <WRAP COLUMN HALF> 
-**2.1.3. Define the LINUX_APP Symbol** 
-  * In the Project Explorer, right click on the project name, select “C/C++ Build Settings” 
-  * In the “C/C++ Build” group, select “Settings” category 
-  * Select “ARM v7 Linux g++ compiler”/”Symbols” node 
-  * Add LINUX_APP definition (using the ‘+’ button) 
- 
-</WRAP> <WRAP COLUMN HALF> 
-{{ :reference:zmod:capture4.1.2.png |}} 
-</WRAP> </WRAP>  
- 
-<WRAP GROUP> <WRAP COLUMN HALF> 
-**2.1.4. Add SYSROOT Environment Variable in the SDK** 
-  * Download the latest eclypse-debian-buster-armhf-sysroot_X.X.tar.gz sysroot from [[https://github.com/Digilent/Eclypse-Z7/releases|Releases]] and extract it on your PC 
-    * You need to expand the Assets section of the git page to find the file mentioned above 
-  * In the Project Explorer, right click on the project name, select “C/C++ Build Settings” 
-  * In the “C/C++ Build” group, select “Environment” category 
-  * Add SYSROOT variable pointing to the location where Petalinux sysroot can be found. For example “/home/cosmin/Documents/eclypse-debian-buster-armhf-sysroot” 
- 
-**Note**: //In Petalinux 2019.1 in order to build the sysroot image is necessary to run the following command: // 
-<code>petalinux-build -c build-sysroots</code> 
- 
-</WRAP> <WRAP COLUMN HALF> 
-{{ :reference:zmod:addsysroot.png|}} 
-</WRAP> </WRAP>  
- 
-<WRAP GROUP> <WRAP COLUMN HALF> 
-**2.1.5. Define Libraries and Library Directories** 
-  * In the Project Explorer, right click on the project name, select “C/C++ Build Settings” 
-  * In the “C/C++ Build” group, select “Settings” category 
-  * Select “ARM v7 Linux g++ linker”/”Libraries” node 
-  * Add the following library in the “Libraries (-l)” list: 
-    * uio 
-  * Add the following directories in the “Library search path (-L)” list: 
-    * **//${SYSROOT}/usr/lib//** 
-    * **//${SYSROOT}/lib//** 
-</WRAP> <WRAP COLUMN HALF> 
-{{ :reference:zmod:capture4.1.5.png|}} 
-</WRAP> </WRAP>  
- 
-<WRAP GROUP> <WRAP COLUMN HALF> 
-**2.1.6. Define Include Directories** 
-  * In the Project Explorer, right click on the project name, select “C/C++ Build Settings” 
-  * In the “C/C++ Build” group, select “Settings” category 
-  * Select “ARM v7 Linux g++ compiler”/”Directories” node 
-  * Add the following directories: 
-    * **//${SYSROOT}/usr/include//** 
-    * **//${CWD}/../../zmodlib/Zmod//** 
-    * **//${CWD}/../../zmodlib/ZmodADC1410//** 
- 
-</WRAP> <WRAP COLUMN HALF> 
-{{ :reference:zmod:capture4.1.4.png |}} 
-</WRAP> </WRAP>  
- 
----- 
- 
-=== 2.2. Baremetal Project Setup=== 
- 
-**2.2.1. Create New Project and Link zmodlib Folder** 
- 
-<WRAP GROUP> <WRAP COLUMN HALF>     
-  It is assumed that Zmod and specific folders for Zmods (ZmodADC1410 for example) are placed in the SDK workspace root folder, as provided by Digilent (see [[#delivery_structure|Delivery Structure]]). 
-  * Create a new application project. 
-  * Under src folder, right click option, select New / Folder 
-  * Select Advanced 
-  * Link to alternate location (Linked Folder) 
-  * **Variables...** -> Select **WORKSPACE_LOC** -> Extend... -> Select **zmodlib** folder 
- 
-</WRAP> <WRAP COLUMN HALF> 
-{{ :reference:zmod:capture4.2.1.png|}} 
-</WRAP></WRAP> 
- 
-<WRAP GROUP> <WRAP COLUMN HALF> 
-**2.2.2. Define Include Directories** 
-  * In the Project Explorer, right click on the project name, select “C/C++ Build Settings” 
-  * In the “C/C++ Build” group, select “Settings” category 
-  * Select “ARM v7 g++ compiler”/”Directories” node 
-  * Add the following directories: 
-    * **//${CWD}/../../zmodlib/Zmod//** 
-    * **//${CWD}/../../zmodlib/ZmodADC1410//** 
- 
-</WRAP> <WRAP COLUMN HALF> 
-{{ :reference:zmod:capture4.2.2.png |}} 
-</WRAP> </WRAP>  
  
 ---- ----