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

ID 683085
Date 3/28/2022
Public
Document Table of Contents

1.2.2. Recommendations for Structuring the Custom Platform Directory

For ease of use, consider adopting the Intel® -recommended directory structure and naming convention when you create an Intel® FPGA SDK for OpenCL™ Pro Edition Custom Platform.

  • Make the INTELFPGAOCLSDKROOT/board directory the location of the board installation, where INTELFPGAOCLSDKROOT points to the location of the SDK installation.
    Attention: Do not remove any existing subdirectories from the INTELFPGAOCLSDKROOT/board directory.
  • Create a <board_vendor_name> subdirectory within the INTELFPGAOCLSDKROOT/board directory to store the Custom Platform.
  • Store the contents of a given Custom Platform in a INTELFPGAOCLSDKROOT/board/<board_vendor_name>/<board_family_name> subdirectory.
  • Assign unique names to software libraries (for example, lib<board_vendor_name>_<board_family_name>.so) to avoid name collisions.

For example, if you (ABC Incorporated) create a Custom Platform for a family of boards named XYZ, set up your Custom Platform such that the SDK user can access XYZ by installing the XYZ Custom Platform in INTELFPGAOCLSDKROOT/board/ABC/XYZ, where INTELFPGAOCLSDKROOT is the environment variable that points to the absolute path to the SDK installation package.