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

1.4.2.1. Creating the board_env.xml File

The board_env.xml file describes your Custom Platform to the SDK.
Together with the other contents of the Custom Platform, the board_env.xml file sets up the board installation that enables the offline compiler to target a specific accelerator board.

A board_env.xml template is available in the /board_package directory of the Custom Platform Toolkit.

  1. Create a board_env top-level XML element. Within board_env, include the following XML elements:
    • hardware
    • platform

      Include a platform element for each operating system that your Custom Platform supports.

  2. Within each platform element, include the following XML elements:
    • mmdlib
    • linkflags
    • linklibs
    • utilbindir
  3. Parameterize each element and corresponding attribute(s) with information specific to your Custom Platform, as outline in the table below:
    Table 2.  Specifications of XML Elements and Attributes in the board_env.xml File
    Element Attribute Description
    board_env version: The SDK's Custom Platform Toolkit release you use to create your Custom Platform.
    Attention: The Custom Platform version must match the SDK version you use to develop the Custom Platform.

    name: Name of the board installation directory containing your Custom Platform.

    hardware dir: Name of the subdirectory, within the board installation directory, that contains the board variants.

    default: The default board variant that the offline compiler targets when the SDK user does not specify an explicit argument for the --board <board_name> offline compiler option.

    platform name: Name of the operating system.

    Refer to the Intel® FPGA SDK for OpenCL™ Pro Edition Getting Started Guide and the Intel® FPGA RTE for OpenCL Pro Edition Getting Started Guide for more information.

    mmdlib A string that specifies the path to the MMD library of your Custom Platform.

    To load multiple libraries, specify them in an ordered, comma-separated list. The host application loads the libraries in the order that they appear in the list.

    Tip: You can use %b to reference your board installation directory.
    linkflags A string that specifies the linker flags necessary for linking with the MMD layer available with the board.
    Tip: You can use %a to reference the SDK installation directory and %b to reference your board installation directory.
    linklibs A string that specifies the libraries the SDK must link against to use the MMD layer available with the board.
    utilbindir Directory in which the SDK expects to locate its utility executables (that is, install, uninstall, program, diagnose, and flash).
    Tip: You can use %a to reference the SDK installation directory and %b to reference your board installation directory.
Your board_env.xml file should resemble the following example: 
<?xml version="1.0"?>
<board_env version="<SDK_version>" name="<Custom_Platform_name>">
  <hardware dir="hardware" default="<board_name>"></hardware>
  <platform name="linux64">
    <mmdlib>%b/linux64/lib/libaltera_<Custom_Platform_name>_mmd.so</mmdlib>
    <linkflags>-L%b/linux64/lib</linkflags>
    <linklibs>-laltera_<Custom_Platform_name>_mmd</linklibs>
    <utilbindir>%b/linux64/libexec</utilbindir>
  </platform>

  <platform name="windows64">
    <mmdlib>%b/windows64/bin/altera_<Custom_Platform_name>_mmd.dll</mmdlib>
    <linkflags>/libpath:%b/windows64/lib</linkflags>
    <linklibs>altera_<Custom_Platform_name>_mmd.lib</linklibs>
    <utilbindir>%b/windows64/libexec</utilbindir>
  </platform>
</board_env>

Where:

  • <SDK_version> is the Intel® FPGA SDK for OpenCL™ Pro Edition version.
  • <Custom_Platform_name> is the name of your Custom Platform (for example, a10_ref).
  • <board_name> is the name of the FPGA board.

Section Content
Testing the board_env.xml File

Related Information
Level Two Title