Intel® FPGA SDK for OpenCL™ Standard Edition: Custom Platform Toolkit User Guide

Download PDF
ID 683398
Date 5/04/2018
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents
Document Table of Contents x
1. Intel® FPGA SDK for OpenCL™ Standard Edition Custom Platform Toolkit User Guide 2. Intel® FPGA SDK for OpenCL™ Standard Edition Custom Platform Toolkit Reference Material
1. Intel® FPGA SDK for OpenCL™ Standard Edition Custom Platform Toolkit User Guide x
1.1. Prerequisites for the Intel® FPGA SDK for OpenCL™ Standard Edition Custom Platform Toolkit 1.2. Overview of the Intel® FPGA SDK for OpenCL™ Standard Edition Custom Platform 1.3. Custom Platform Automigration for Forward Compatibility 1.4. Creating an Intel® FPGA SDK for OpenCL™ Standard Edition Custom Platform 1.5. Applying for the Intel® FPGA SDK for OpenCL™ Standard Edition Preferred Board Status 1.6. Shipping Recommendations 1.7. Intel® FPGA SDK for OpenCL™ Standard Edition Custom Platform Design Revision History
1.2. Overview of the Intel® FPGA SDK for OpenCL™ Standard Edition Custom Platform x
1.2.1. Directories and Files in an Intel® FPGA SDK for OpenCL™ Standard Edition Custom Platform 1.2.2. Recommendations for Structuring the Custom Platform Directory
1.3. Custom Platform Automigration for Forward Compatibility x
1.3.1. Customizing Automigration
1.4. Creating an Intel® FPGA SDK for OpenCL™ Standard Edition Custom Platform x
1.4.1. Designing the Board Hardware 1.4.2. Creating the Board XML Files 1.4.3. Creating the MMD Library 1.4.4. Setting Up the FPGA Client Driver 1.4.5. Providing Intel® FPGA SDK for OpenCL™ Standard Edition Utilities Support 1.4.6. Testing the Hardware Design
1.4.1. Designing the Board Hardware x
1.4.1.1. Creating the Board Platform Designer (Standard) System 1.4.1.2. Establishing Guaranteed Timing Flow
1.4.1.1. Creating the Board Platform Designer (Standard) System x
1.4.1.1.1. General Quality of Results Considerations for the Exported Board Partition
1.4.2. Creating the Board XML Files x
1.4.2.1. Creating the board_env.xml File 1.4.2.2. Creating the board_spec.xml File
1.4.2.1. Creating the board_env.xml File x
1.4.2.1.1. Testing the board_env.xml File
1.4.3. Creating the MMD Library x
1.4.3.1. Kernel Power-up State
2. Intel® FPGA SDK for OpenCL™ Standard Edition Custom Platform Toolkit Reference Material x
2.1. The Board Platform Designer (Standard) Subsystem 2.2. XML Elements, Attributes, and Parameters in the board_spec.xml File 2.3. MMD API Descriptions 2.4. Intel® FPGA SDK for OpenCL™ Standard Edition Custom Platform Toolkit Reference Manual Revision History
2.1. The Board Platform Designer (Standard) Subsystem x
2.1.1. Intel® FPGA SDK for OpenCL™ Standard Edition-Specific Platform Designer (Standard) System Components
2.1.1. Intel® FPGA SDK for OpenCL™ Standard Edition-Specific Platform Designer (Standard) System Components x
2.1.1.1. OpenCL Kernel Clock Generator 2.1.1.2. OpenCL Kernel Interface 2.1.1.3. OpenCL Memory Bank Divider
2.2. XML Elements, Attributes, and Parameters in the board_spec.xml File x
2.2.1. board 2.2.2. device 2.2.3. global_mem 2.2.4. host 2.2.5. channels 2.2.6. interfaces 2.2.7. interface 2.2.8. compile
2.3. MMD API Descriptions x
2.3.1. aocl_mmd_get_offline_info 2.3.2. aocl_mmd_get_info 2.3.3. aocl_mmd_open 2.3.4. aocl_mmd_close 2.3.5. aocl_mmd_read 2.3.6. aocl_mmd_write 2.3.7. aocl_mmd_copy 2.3.8. aocl_mmd_set_interrupt_handler 2.3.9. aocl_mmd_set_status_handler 2.3.10. aocl_mmd_yield 2.3.11. aocl_mmd_shared_mem_alloc 2.3.12. aocl_mmd_shared_mem_free 2.3.13. aocl_mmd_reprogram 2.3.14. aocl_mmd_hostchannel_create 2.3.15. aocl_mmd_hostchannel_destroy 2.3.16. aocl_mmd_hostchannel_get_buffer 2.3.17. aocl_mmd_hostchannel_ack_buffer
2.3.13. aocl_mmd_reprogram x
2.3.13.1. Reprogram Support
1. Intel® FPGA SDK for OpenCL™ Standard Edition Custom Platform Toolkit User Guide
2. Intel® FPGA SDK for OpenCL™ Standard Edition Custom Platform Toolkit Reference Material

1.7. Intel® FPGA SDK for OpenCL™ Standard Edition Custom Platform Design Revision History

Document Version Intel® Quartus® Prime Version Changes
2018.05.04 18.0
  • Removed information pertaining to the Intel® FPGA SDK for OpenCL™ Pro Edition and the Intel® Quartus® Prime Pro Edition software.
  • In Creating the board_spec.xml File, added a note to specify that when creating a device model (i.e. <part_number>_dm.xml), <part_number> must be the official Intel® FPGA device part number.
Table 4.  Document Revision History of the Intel® FPGA SDK for OpenCL™ Custom Platform Design Chapter of the Intel® FPGA SDK for OpenCL™ Custom Platform Toolkit User Guide
Date Version Changes
November 2017 2017.11.03
  • Rebranded the references to the following:
    • ALTERAOCLSDKROOT to INTELFPGAOCLSDKROOT
    • Arria 10 to Intel® Arria® 10
    • Qsys to Platform Designer (Standard)
  • In Setting Up the FPGA Client Driver, updated the /opt/Altera/OpenCL/Boards/ directory to /opt/Intel/OpenCL/Boards/
  • Updated instances of aocl install to aocl install <path_to_customplatform>.
  • Updated instances of aocl uninstall to aocl uninstall <path_to_customplatform>.
  • Removed references to AOCL_BOARD_PACKAGE_ROOT throughout the guide since it is deprecated.
  • In Creating the board_env.xml File, updated the board_env version to 17.1 in the board_env.xml file.
  • In Testing the board_env.xml File, updated board_default and board-version values.
  • In Creating the board_spec.xml File, updated the board_spec.xml file code example.
  • Implemented the conventions single dash and -option=<value> in the following topics:
    • Customizing Automigration
    • Testing the board_env.xml File
    • Testing the Hardware Design
    • Applying for the Intel® FPGA SDK for OpenCL™ Preferred Board Status
May 2017 2017.05.08
  • Rebranded Altera Client Driver (ACD) to FPGA Client Driver (FCD).
  • Updated example code of the board_env.xml and board_spec.xml files to the 17.0 version of corresponding files in the Arria® 10 GX FPGA Development Kit Reference Platform.
October 2016 2016.10.31
  • Rebranded Altera SDK for OpenCL to Intel® FPGA SDK for OpenCL™ .
  • Rebranded Altera Offline Compiler to Intel® FPGA SDK for OpenCL™ Offline Compiler.
  • Updated example code of the board_env.xml and board_spec.xml files to the 16.1 version of corresponding files in the Arria® 10 GX FPGA Development Kit Reference Platform.
  • In Setting Up the Altera Client Driver, updated the text for clarity.
  • In Testing the Hardware Design, modified the Windows make command in Step 5 to make -f Makefile.windows.
May 2016 2016.05.02
  • In Creating the board_spec.xml File, updated the example XML code for board_spec.xml to the current version, and updated the examples embedded in the procedure to match the example .xml file.
  • Updated implementation requirement for the program utility in the Providing AOCL Utilities Support section.
  • In Setting Up the Altera Client Driver, modified the Linux directory for the .acd file from /opt/Altera/OpenCL_boards/ to /opt/Altera/OpenCL/Boards/.
November 2015 2015.11.02
  • Changed instances of Quartus® II to Quartus Prime.
  • Changed instances of Altera® Complete Design Suite to Intel® Quartus® Prime Design Suite .
  • Updated the support requirement for the diagnose utility in the Providing AOCL Utilities Support section.
  • In the Creating the board_env.xml File section, added the mmdlib XML element to the list of elements included in the board_env.xml file.
May 2015 15.0.0
  • Added the Setting Up the Altera Client Driver section.
December 2014 14.1.0
  • Specified that the Custom Platform Toolkit is available in the ALTERAOCLSDKROOT/board directory.
  • Added the uninstall utility executable in the Providing AOCL Utilities Support section.
  • Indicated that the version attributes in the board_env.xml and board_spec.xml files have to match the Altera® Complete Design Suite and Altera SDK for OpenCL™ version you use to develop the Custom Platform.
  • Added instruction for including the compile eXtensible Markup Language element and its associated attributes in the board_spec.xml file in the section Creating the board_spec.xml File.
  • Added information on the automigration of Custom Platform in sections Custom Platform Automigration and Customizing Automigration.
  • Removed the Generating the Rapid Prototyping Library section.
October 2014 14.0.1
  • Reorganized existing document into two chapters.
June 2014 14.0.0
  • Initial release.
Level Two Title