Wiki

Analog Devices Wiki

English
English
简体中文
简体中文
日本語
日本語
Руccкий
Руccкий

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
Next revisionBoth sides next revision
resources:fpga:docs:hdl:porting_project_quick_start_guide [09 Jan 2018 10:32] – Fix a few grammar mistakes and add a tip related to Xilinx boards Istvan Csomortaniresources:fpga:docs:hdl:porting_project_quick_start_guide [21 Mar 2018 13:55] – The example with a Xilinx standalone project is redundant Istvan Csomortani
Line 1: Line 1:
 ====== Porting ADI's HDL reference designs ====== ====== Porting ADI's HDL reference designs ======
  
-In general, a given reference design of an FMC board is deployed to just a few carrier, although several [[https://github.com/analogdevicesinc/hdl/tree/master/projects/common|FPGA board]] is supported in ADI's HDL repository. The simple reason behind this practice is that it would create a tremendous maintenance workload, that would require a lot of human resources, and would increase the required time for testing. The general rule of thumb is to support a given project with a fairly popular carrier (e.g. ZC706 or A10SoC), which is powerful enough to showcase the board features and maximum performance.+In general, a given reference design for an FMC board is deployed to just a few carriers, although several [[https://github.com/analogdevicesinc/hdl/tree/master/projects/common|FPGA boards]] are supported in ADI's HDL repository. The simple reason behind this practice is that it would create a tremendous maintenance workload, that would require a lot of human resources, and would increase the required time for testing. The general rule of thumb is to support a given project with a fairly popular carrier (e.g. ZC706 or A10SoC), which is powerful enough to showcase the board features and maximum performance.
 All the HDL projects were designed to maximize source code reuse, minimize maintainability and simplify portability. The result of these design goals is that porting a given project to another carrier is fairly simple if the user respects a couple of guidelines. The main scope of this wiki page is to discuss these guidelines and provide simple indications for users who wants to port a project to a non-supported carrier.   All the HDL projects were designed to maximize source code reuse, minimize maintainability and simplify portability. The result of these design goals is that porting a given project to another carrier is fairly simple if the user respects a couple of guidelines. The main scope of this wiki page is to discuss these guidelines and provide simple indications for users who wants to port a project to a non-supported carrier.  
  
 ===== Quick Compatibility Check ===== ===== Quick Compatibility Check =====
  
-<note>All ADI's FPGA Mezzanine Cards (FMC) are designed to respect all the specifications and requirements defined in the ANSI/VITA 57.1 FPGA Mezzanine Card Standard. (if not other way stated on board's wiki page) If the new FPGA carrier is fully compliant with this standard, +<note>All ADI's FPGA Mezzanine Cards (FMC) are designed to respect all the specifications and requirements defined in the ANSI/VITA 57.1 FPGA Mezzanine Card Standard (if not otherwise stated on board's wiki page). If the new FPGA carrier is fully compliant with this standard, there will be no obstacles preventing the user to port the project to the required carrier card.</note>
- there will be no obstacles, which prevents the user to port the project to the required carrier card.</note>+
  
-There is two type of FMC connector: LPC (Low Pin Count) and HPC (High Pin Count). In general, an FMC board is using the FMC connector type, which has enough pins for the required interfaces between the IO devices and FPGA. A carrier with an FMC HPC connector can host FMC board with an LPC or HPC connector, but a carrier with an FMC LPC can host a board just with an FMC LPC connector.+There are two types of FMC connector: LPC (Low Pin Count) and HPC (High Pin Count). In general, an FMC board is using the FMC connector type that has enough pins for the required interfaces between the IO devices and FPGA. A carrier with an FMC HPC connector can host FMC boards with an LPC or HPC connector, but a carrier with an FMC LPC can host a board just with an FMC LPC connector.
  
-<note tip>First always check out the already available [[https://github.com/analogdevicesinc/hdl/tree/dev/projects/common|base designs]]. If your board is present among our supported base designs, you do not need to verify the following things, you can jump to the Project creation section</note>+<note tip>First, always check out the already available [[https://github.com/analogdevicesinc/hdl/tree/dev/projects/common|base designs]]. If your board is present among our supported base designs, you do not need to verify the following things and can jump to the Project creation section</note>
  
-The most important things to check before porting, are related to the ANSI/VITA 57.1 standard (the list is not necessarily exhaustive):+The most important things to check before porting are related to the ANSI/VITA 57.1 standard (the list is not necessarily exhaustive):
  
   * Power and ground lines - 3P3V/3P3VAUX/12P0V/GND   * Power and ground lines - 3P3V/3P3VAUX/12P0V/GND
Line 20: Line 19:
   * Dedicated pins for transceiver lines (DPx_[M2C|C2M]_[P|N])   * Dedicated pins for transceiver lines (DPx_[M2C|C2M]_[P|N])
  
-<note important>To check all the requirements please refer to the ANSI/VITA 57.1 standard. The above few hints do not cover all the FMC standard, and you may miss something that can prevent to port the project.</note> +<note important>To check all the requirements please refer to the ANSI/VITA 57.1 standard. The above few hints do not cover all the FMC standard and you may miss something that can prevent the port of the project.</note> 
  
-<note tip>Make sure, that you've reviewed all the documentation and design files in order to know the electrical specifications and/or requirements of the FMC board. If you're not sure, ask!</note>+<note tip>Make sure that you've reviewed all the documentation and design files in order to know the electrical specifications and/or requirements of the FMC board. If you're not sure, ask!</note>
  
 ===== Base design files ===== ===== Base design files =====
Line 38: Line 37:
  
 The **zcu102** directory must contain the following files: The **zcu102** directory must contain the following files:
-  * **zcu102_system_bd.tcl** - This script describe's the base block design. +  * **zcu102_system_bd.tcl** - This script describes the base block design 
-  * **zcu102_system_constr.xdc** - IO constraint file for the base design. Will contain IO definitions for GPIO, switches, LEDs or other peripherals of the board.+  * **zcu102_system_constr.xdc** - IO constraint file for the base design. Will contain IO definitions for GPIO, switches, LEDs or other peripherals of the board
   * MIG configuration file (if needed) - This file can be borrowed for the golden reference design of the board   * MIG configuration file (if needed) - This file can be borrowed for the golden reference design of the board
   * other constraints files if needed    * other constraints files if needed 
Line 60: Line 59:
 ==== Example with an Intel board ==== ==== Example with an Intel board ====
  
-To create a new base design for a given Intel FPGA carrier board, the following steps should be taken (the zcu102 carrier was used as an example).+To create a new base design for a given Intel FPGA carrier board the following steps should be taken (the a10soc carrier was used as an example).
  
 The following files should be created or copied into the directory: The following files should be created or copied into the directory:
Line 76: Line 75:
 ===== Project files for Xilinx boards ===== ===== Project files for Xilinx boards =====
  
-To follow the project framework as much as possible, the easiest way is to copy all the projects file from an already existing project and modifying those file to support the new carrier. A project for a Xilinx FPGA board should contain the following files:+To follow the project framework as much as possible the easiest way is to copy all the projects files from an already existing project and modifying those file to support the new carrier. A project for a Xilinx FPGA board should contain the following files:
  
-  * **system_project.tcl** - This script is creating the actual Vivado project and run the synthesis/implementation of the design. The name of the carrier must be updated.+  * **system_project.tcl** - This script is creating the actual Vivado project and runs the synthesis/implementation of the design. The name of the carrier must be updated.
  
   * **system_bd.tcl** - In this file is sourced the base design's Tcl script and the board design's Tcl script. The name of the carrier must be updated.   * **system_bd.tcl** - In this file is sourced the base design's Tcl script and the board design's Tcl script. The name of the carrier must be updated.
Line 84: Line 83:
   * **system_constr.xdc** - Constraint files of the board design. Here is defined the FMC IO's and board specific clock signals. All the IO definition must be updated, with the new pin names.   * **system_constr.xdc** - Constraint files of the board design. Here is defined the FMC IO's and board specific clock signals. All the IO definition must be updated, with the new pin names.
      
-  * **system_top.v** - Top wrapper file, in which the system_wrapper.v module is instantiated, and a few I/O macro is defined. The IO port of this verilog module will be connected to actual IO pads of the FPGA. The simplest way to update the system_top is to let the synthesis fail, and the tool will tell which ports are missing or which ports are redundant. The first thing to do after the failure is to verify the instantiation of the system_wrapper.v. This file is a tool generated file and can be found at <project_name>.srcs/sources_1/bd/system/hdl/system_wrapper.v. Fixing the instantiation of the wrapper module in most cases eliminate all the errors. If you get errors that you can not fix, ask for support.+  * **system_top.v** - Top wrapper file, in which the system_wrapper.v module is instantiated, and a few I/O macros are defined. The IO port of this Verilog module will be connected to actual IO pads of the FPGA. The simplest way to update the system_top is to let the synthesis fail and the tool will tell which ports are missing or which ports are redundant. The first thing to do after the failure is to verify the instantiation of the system_wrapper.v. This file is a tool generated file and can be found at <project_name>.srcs/sources_1/bd/system/hdl/system_wrapper.v. Fixing the instantiation of the wrapper module in most cases eliminates all the errors. If you get errors that you can not fix, ask for support.
  
   * **Makefile** - This is an auto-generated file, but after updating the carrier name, should work with the new project without an issue.   * **Makefile** - This is an auto-generated file, but after updating the carrier name, should work with the new project without an issue.
Line 90: Line 89:
 ===== Project files for Intel boards ===== ===== Project files for Intel boards =====
  
-To follow the project framework as much as possible, the easiest way is to copy all the projects file from an already existing project and modifying those file to support the new carrier. A project for an Intel FPGA board should contain the following files:+To follow the project framework as much as possible the easiest way is to copy all the projects file from an already existing project and modifying those files to support the new carrier. A project for an Intel FPGA board should contain the following files:
  
   * **system_project.tcl** - This script is creating the actual Quartus project and run the synthesis/implementation of the design. It also contains the IO definitions for the interfaces between the FMC board and FPGA. The carrier name and all the IO pin names must be updated.   * **system_project.tcl** - This script is creating the actual Quartus project and run the synthesis/implementation of the design. It also contains the IO definitions for the interfaces between the FMC board and FPGA. The carrier name and all the IO pin names must be updated.
Line 96: Line 95:
   * **system_qsys.tcl** - In this file is sourced the base design's Tcl script and the board design's Tcl script. The name of the carrier must be updated.   * **system_qsys.tcl** - In this file is sourced the base design's Tcl script and the board design's Tcl script. The name of the carrier must be updated.
  
-  * **system_constr.sdc** - Contains clock definitions and other proprieties path constraints+  * **system_constr.sdc** - Contains clock definitions and other path constraints
  
-  * **system_top.v** - Top wrapper file of the project. The IO port of this verilog module will be actual IO pads of the FPGA. Need to make sure, that the base design's IOs are updated. (Delete nonexistent IO or add new ones.) The simplest way to update the system_top is to let the synthesis fail, and the tool will tell which ports are missing or which ports are redundant.+  * **system_top.v** - Top wrapper file of the project. The IO port of this Verilog module will be actual IO pads of the FPGA. Need to make sure that the base design's IOs are updated. (Delete nonexistent IO or add new ones). The simplest way to update the system_top is to let the synthesis fail and the tool will tell which ports are missing or which ports are redundant.
  
-  * **Makefile** - This is an auto-generated file, but after updating the carrier name, should work with the new project without an issue.+  * **Makefile** - This is an auto-generated file, but after updating the carrier name, it should work with the new project without an issue.
  
 ===== Help and support ===== ===== Help and support =====
resources/fpga/docs/hdl/porting_project_quick_start_guide.txt · Last modified: 08 Apr 2024 14:32 by iulia Moldovan

Page Tools