Intel® FPGA SDK for OpenCL™ Pro Edition: Custom Platform Toolkit User Guide
ID
683085
Date
3/28/2022
Public
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.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
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
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.