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

Download PDF
ID 683085
Date 3/28/2022
Public
Document Table of Contents
Document Table of Contents x
1. Intel® FPGA SDK for OpenCL™ Pro Edition Custom Platform Toolkit User Guide 2. Intel® FPGA SDK for OpenCL™ Pro Edition Custom Platform Toolkit Reference Material 3. Intel FPGA SDK for OpenCL Pro Edition Custom Platform Toolkit Archives 4. Document Revision History for Intel® FPGA SDK for OpenCL™ Pro Edition Custom Platform Toolkit User Guide
1. Intel® FPGA SDK for OpenCL™ Pro Edition Custom Platform Toolkit User Guide x
1.1. Prerequisites for the Intel® FPGA SDK for OpenCL™ Pro Edition Custom Platform Toolkit 1.2. Overview of the Intel® FPGA SDK for OpenCL™ Pro Edition Custom Platform 1.3. Custom Platform Automigration for Forward Compatibility 1.4. Creating an Intel® FPGA SDK for OpenCL™ Custom Platform 1.5. Applying for the Intel® FPGA SDK for OpenCL™ Pro Edition Preferred Board Status 1.6. Shipping Recommendations
1.2. Overview of the Intel® FPGA SDK for OpenCL™ Pro Edition Custom Platform x
1.2.1. Directories and Files in an Intel® FPGA SDK for OpenCL™ Pro 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™ 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™ 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 System 1.4.1.2. Establishing Guaranteed Timing Flow
1.4.1.1. Creating the Board Platform Designer 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™ Pro Edition Custom Platform Toolkit Reference Material x
2.1. The Board Platform Designer Subsystem 2.2. XML Elements, Attributes, and Parameters in the board_spec.xml File 2.3. MMD API Descriptions
2.1. The Board Platform Designer Subsystem x
2.1.1. Intel® FPGA SDK for OpenCL™ Pro Edition-Specific Platform Designer System Components
2.1.1. Intel® FPGA SDK for OpenCL™ Pro Edition-Specific Platform Designer 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_device_interrupt_handler 2.3.10. aocl_mmd_set_status_handler 2.3.11. aocl_mmd_yield 2.3.12. aocl_mmd_shared_mem_alloc 2.3.13. aocl_mmd_shared_mem_free 2.3.14. aocl_mmd_program 2.3.15. aocl_mmd_reprogram 2.3.16. aocl_mmd_hostchannel_create 2.3.17. aocl_mmd_hostchannel_destroy 2.3.18. aocl_mmd_hostchannel_get_buffer 2.3.19. aocl_mmd_hostchannel_ack_buffer 2.3.20. aocl_mmd_host_alloc 2.3.21. aocl_mmd_free 2.3.22. aocl_mmd_device_alloc 2.3.23. aocl_mmd_shared_alloc 2.3.24. aocl_mmd_shared_migrate
2.3.14. aocl_mmd_program x
2.3.14.1. Program Support
1. Intel® FPGA SDK for OpenCL™ Pro Edition Custom Platform Toolkit User Guide
2. Intel® FPGA SDK for OpenCL™ Pro Edition Custom Platform Toolkit Reference Material
3. Intel FPGA SDK for OpenCL Pro Edition Custom Platform Toolkit Archives
4. Document Revision History for Intel® FPGA SDK for OpenCL™ Pro Edition Custom Platform Toolkit User Guide

4. Document Revision History for Intel® FPGA SDK for OpenCL™ Pro Edition Custom Platform Toolkit User Guide

Document Version Intel® Quartus® Prime Version Changes
2022.03.28 20.3
  • Updated the terms master and slave to host and agent, respectively.
2020.09.28 20.3
  • Added the allocation_type attribute in global_mem topic.
  • Added more enum values and capability values in aocl_mmd_get_info topic
  • Added the following APIs:
    • aocl_mmd_host_alloc
    • aocl_mmd_free
    • aocl_mmd_device_alloc
    • aocl_mmd_shared_alloc
    • aocl_mmd_shared_migrate
  • Deprecated aocl_mmd_shared_mem_alloc and aocl_mmd_shared_mem_free APIs.
  • Updated the directories list in Directories and Files in an Intel® FPGA SDK for OpenCL™ Pro Edition Custom Platform
  • Updated the Example System Hierarchy diagram to remove the reference to system.qsys in Designing the Board Hardware.
  • Removed all occurrences of system.qsys and replaced it with board.qsys.
  • Removed all references to INTELFPGAOCLSDKROOT/board/custom_platform_toolkit/ path and replaced some of them with a reference to the BSP download location.
  • Removed a note about alterahalmmd library for linklibs element in Creating the board_env.xml File.
  • Removed alterahalmmd.lib from the SDK output in Testing the board_env.xml File.
  • Changed pll_refclk to kernel_pll_refclk in OpenCL Kernel Clock Generator.
  • Changed kernel_ctrl to ctrl in OpenCL Kernel Interface.
  • Added a brief note for acl_bsp_memorg_host in OpenCL Memory Bank Divider.
  • In Creating the MMD Library and MMD API Descriptions, changed the reference details for aocl_mmd.h file.
  • Removed the step to set AOCL_BOARD_TOOLKIT_ROOT environment variable in Testing the board_env.xml File.
2020.04.13 20.1
  • Removed a note about interleaved_bytes in Creating the board_spec.xml File topic.
  • Updated the description of Burst size (maximum) parameter in OpenCL Memory Bank Divider topic.
  • Added recommended values for the Maximum Pending Reads parameter in OpenCL Memory Bank Divider topic.
  • Updated the description of interleaved_bytes in global_mem topic.
  • Updated the description of maxburst in interface topic.
2018.10.26 18.1
  • Updated Creating the board_spec.xml File and global_mem to include requirement that default global memory must start at address 0x0.
  • Merged Intel® FPGA SDK for OpenCL™ Pro Edition Custom Platform Design Revision History and Intel® FPGA SDK for OpenCL™ Pro Edition Custom Platform Toolkit Reference Manual Revision History.
2018.07.16 18.0
2018.05.04 18.0
  • Removed information pertaining to the Intel® FPGA SDK for OpenCL™ Standard Edition and the Intel® Quartus® Prime Standard Edition software.
  • In Prerequisites for the Intel FPGA SDK for OpenCL Pro Edition Custom Platform Toolkit, updated the list of related documents to refer to the Intel® Arria® 10 FPGA and SoC Reference Platforms.
  • 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.
  • In interface, added information on the waitrequest_allowance parameter.
  • In compile:
    • Added more information on compiler behavior when qsys_file is set to none.
    • Added s10_ref and none to the list of valid values for auto-migrate.
  • Under MMD API Descriptions, added a topic for the new aocl_mmd_set_device_interrupt_handler API.
Date Version Changes
November 2017 2017.11.03
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.
  • In OpenCL Memory Bank Divider, added information about the Split read/write bursts on burst word boundary parameter.
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/.
  • In the global_mem section under XML Elements, Attributes, and Parameters in the board_spec.xml File, added example calculations for determining the max_bandwidth value.
  • In the interface section under XML Elements, Attributes, and Parameters in the board_spec.xml File, modified the global_mem-specific definitions for the name and port attributes.
  • Added the option to assign a value of none to the qsys_file attribute within the compile element.
  • Fixed a documentation error in the aocl_mmd_copy section.
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.
  • Under XML Elements, Attributes, and Parameters in the board_spec.xml File, added information on the compile eXtensible Markup Language element and its associated attributes and parameters.
  • Under MMD API Descriptions, added information on the AOCL_MMD_USES_YIELD and the AOCL_MMD_MEM_TYPES_SUPPORTED enum values for the requested_info_id variable in the aocl_mmd_get_offline_info function.
October 2014 14.0.1
  • Reorganized existing document into two chapters.
June 2014 14.0.0
  • Initial release.
Level Two Title