Releases: OFS/opae-sdk
opae-sdk-2.2.0
Open Programmable Acceleration Engine (OPAE) 2.2.0 Release Notes
OPAE 2.2.0-1 release provides SDK, tools, and Linux kernel driver. The main feature of this release is to support Intel® FPGA Device Feature List (DFL) Driver that has been upstreamed to Linux Kernel version up to v6.1.0.
System Compatibility
• Intel® FPGA Programmable Acceleration Card N3000 Production Release: Tested on Fedora 38 system with Intel FPGA DFL Kernel v6.1.0-rc1 Driver
Major Changes from 2.1.0 to 2.2.0
• Added support to FPGA Linux kernel Device Feature List (DFL) driver.
• Added support to PAC card series and Acceleration Development Platforms (ADP) cards.
• Added opae.io, ofs.uio, vabtool etc tools.
• Added opae.cfg to support FPGA platforms and devices.
• Various bug fixes
• Various Static code scan bug fixes
• Updated OPAE documentation.
Source Code
OPAE SDK and tools source code:
Branch: https://github.com/OPAE/opae-sdk/tree/release/2.2.0
tag: 2.2.0-1 : https://github.com/OFS/opae-sdk/releases/tag/2.2.0-1
Intel® FPGA DFL Linux driver source code:
Branch: https://github.com/OFS/linux-dfl/tree/fpga-upstream-dev-6.1-rc1
tag: ofs-2023.1-1 : https://github.com/OFS/linux-dfl/releases/tag/ofs-2023.1-1
Notes/Known Issues
FPGA DFL kernel driver upstreaming to Linux kernel is ongoing.
opae-sdk-2.1.0-2
Open Programmable Acceleration Engine (OPAE) 2.1.0-2 Release Notes
OPAE 2.1.0-2 release provides SDK, tools, and Linux kernel driver. The main feature of this release is to support Intel® FPGA Device Feature List (DFL) Driver that has been upstreamed to Linux Kernel version up to v5.17.
Systems Compatibility
- Intel® FPGA Programmable Acceleration Card N3000 Production Release: Tested on Fedora 37 system with Intel FPGA DFL Kernel v5.17-rc8 Driver
- Intel® FPGA Programmable Acceleration Card N6000 OFS2022.1 Release: Tested on CentOS Stream8.x with Intel FPGA DFL Kernel v5.15-lts Driver
Major Changes from 2.1.0-1 to 2.1.0-2
- Update pybind11 version to 2.10.0
Source Code
- OPAE SDK and tools source code:
Tag: 2.1.0-2: https://github.com/OPAE/opae-sdk/tree/2.1.0-2
Branch: https://github.com/OPAE/opae-sdk/tree/release/2.1.0 - Intel® FPGA DFL Linux driver source code for Intel® FPGA Programmable Acceleration Card N3000 Production Release:
Tag: opae-2.1.0-1: https://github.com/OPAE/linux-dfl/tree/opae-2.1.0-1
Branch: https://github.com/OPAE/linux-dfl/tree/fpga-upstream-dev-5.17-rc8 - Intel® FPGA DFL Linux driver source code for Intel® FPGA Programmable Acceleration Card N6000 OFS2022.1 Release:
Tag: ofs-2022-1: https://github.com/OPAE/linux-dfl/tree/ofs-2022.1-1
Branch: https://github.com/OPAE/linux-dfl/tree/fpga-ofs-dev-5.15-lts
Notes/Known Issues
- FPGA DFL kernel driver upstreaming to Linux kernel is ongoing.
opae-sdk-2.1.0-1
Open Programmable Acceleration Engine (OPAE) 2.1.0-1 Release Notes
OPAE 2.1.0-1 release provides SDK, tools, and Linux kernel driver. The main feature of this release is to support Intel® FPGA Device Feature List (DFL) Driver that has been upstreamed to Linux Kernel version up to v5.17.
Systems Compatibility
- Intel® FPGA Programmable Acceleration Card N3000 Production Release: Tested on Fedora 34 system with Intel FPGA DFL Kernel v5.17-rc8 Driver
- Intel® FPGA Programmable Acceleration Card N6000 OFS2022.1 Release: Tested on CentOS Stream8.x with Intel FPGA DFL Kernel v5.15-lts Driver
Major Changes from 2.0.0-2 to 2.1.0-1
- OPAE SDK repository restructure. Please see OPAE Wiki news.
- Updated OPAE spec file and tarball generation script.
- Added support to Intel® FPGA DFL Driver that has been upstreamed to Linux Kernel v5.7-5.17.
- Added support to Intel® FPGA Programmable Acceleration Card N6000.
- Removed OPAE-SIM from OPAE-SDK.
- Various bug fixes
- Updated OPAE documentation. Please see OPAE2.1.0 Document and DFL Driver Document.
Source Code
- OPAE SDK and tools source code:
Tag: 2.1.0-1: https://github.com/OPAE/opae-sdk/tree/2.1.0-1
Branch: https://github.com/OPAE/opae-sdk/tree/release/2.1.0 - Intel® FPGA DFL Linux driver source code for Intel® FPGA Programmable Acceleration Card N3000 Production Release:
Tag: opae-2.1.0-1: https://github.com/OPAE/linux-dfl/tree/opae-2.1.0-1
Branch: https://github.com/OPAE/linux-dfl/tree/fpga-upstream-dev-5.17-rc8 - Intel® FPGA DFL Linux driver source code for Intel® FPGA Programmable Acceleration Card N6000 OFS2022.1 Release:
Tag: ofs-2022-1: https://github.com/OPAE/linux-dfl/tree/ofs-2022.1-1
Branch: https://github.com/OPAE/linux-dfl/tree/fpga-ofs-dev-5.15-lts
Notes/Known Issues
- FPGA DFL kernel driver upstreaming to Linux kernel is ongoing.
opae-sdk-2.0.0-2
Open Programmable Acceleration Engine (OPAE) 2.0.0-2 Release Notes
OPAE 2.0.0-2 release provides the following bug fixes. For detailed list of supported features, system compatibility, and known issues please see OPAE 2.0.0 Release Notes.
- Update OPAE spec file and tarball generation script
- Fix build error
opae-sdk-2.0.0
Open Programmable Acceleration Engine (OPAE) 2.0.0 Release Notes
OPAE 2.0.0 release provides SDK, tools, and Linux kernel driver. The main feature of this release is to support Intel® FPGA Programmable Acceleration Card N3000 series.
System Compatibility
- Hardware: Tightly coupled FPGA products and programmable FPGA acceleration cards for Intel(R) Xeon(R) processors:
o Intel® FPGA Programmable Acceleration Card N3000-2 Production Release
o Intel® FPGA Programmable Acceleration Card N3000-V Production Release
o Intel® FPGA Programmable Acceleration Card N3000-3 Production Release - Operating System: Tested on Fedora 31 with Linux Kernel 5.8 version.
Major Changes from 1.4.1 to 2.0.0
- Added support to FPGA Linux kernel Device Feature List (DFL) driver.
- Added support to PAC card N3000 series.
- Added PACSign, bitstreaminfo, fpgasupdate, rsu, fpgaport python tools.
- Added ethernet tools for PAC card N3000.
- Various bug fixes
- Various memory leak fixes.
- Various Static code scan bug fixes
- Added python3 support.
- OPAE USMG API are deprecated.
- Updated OPAE documentation.
Source Code
-
FPGA DFL Linux driver source code: tag 2.0.0-1
o https://github.com/OPAE/linux-dfl/tree/fpga-upstream-dev-5.8.0 -
SDK and tools source code: tag 2.0.0-1
o https://github.com/OPAE/opae-sdk/tree/release/2.0.0
o https://github.com/OPAE/opae-libs/tree/release/2.0.0
o https://github.com/OPAE/opae-legacy/tree/release/2.0.0
o https://github.com/OPAE/opae-test/tree/release/2.0.0
Notes/Known Issues
- FPGA DFL kernel driver upstreaming to Linux kernel is ongoing.
- OPAE 2.0.0 is not be compatible with Intel production FPGA driver.
opae-sdk-1.3.7-5
OPAE SDK 1.3.7-5 supports Intel® FPGA Programmable Acceleration Card N3000-V Version 1.2 production release. This release includes an improved OPAE FPGA Driver and PACSign Tool support for newer OpenSSL library. This is a custom release.
To access the general Intel Acceleration Stack for Intel FPGA Programmable Acceleration Card N3000 production releases please download from the following site.
opae-sdk-1.3.7-VC
OPAE SDK 1.3.7-VC supports Intel® FPGA Programmable Acceleration Card N3000-V Version 1.2 production release. This is a custom release.
To access the general Intel® FPGA Programmable Acceleration Card N3000 Version 1.1 production release please download from the following site.
https://www.intel.com/content/www/us/en/programmable/products/boards_and_kits/dev-kits/altera/intel-fpga-pac-n3000/getting-started.html
opae-sdk-1.4.1
Open Programmable Acceleration Engine (OPAE) 1.4.1 Release Notes
OPAE 1.4.1 release provides SDK and tools that have been incorporated into Fedora to support FPGA kernel driver that is upstreamed to Linux 5.6 kernel as of March 2020. The main features of this release are:
- Basic functionalities including PR (Programmable Region?), PCIe, FME (FPGA Management Engine), and AFU (Accelerator Functional Unit)
- SRIOV, Error Handling, User Clock
The driver can be found here:
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/tree/drivers?h=linux-5.6.y
System Compatibility
- Hardware: tightly coupled FPGA products and programmable FPGA acceleration cards for Intel(R) Xeon(R) processors:
o Intel(R) PAC with Arria(R) 10 GX FPGA (PCI ID: 0x09c4) FIM version 1.1.2-1 (1.2 Production) - Operating System: Tested on Fedora 31 with Linux Kernel 5.6
Major Changes from 1.4.0 to 1.4.1
- OPAE git repository layout changes
The opae-sdk repository has been reorganized into five total repositories.
The following table describes the repositories and how they are integrated into opae-sdk.
Repository | Description | Integration |
---|---|---|
opae-sdk | Contains tools built on top of OPAE libraries and/or kernel interfaces. | Master repository. |
opae-libs | Contains libraries that implement the OPAE APIs. | Added as a git subtree to opae-sdk/opae-libs. |
opae-legacy | Contains legacy tools designed for Skylake + FPGA platforms. | Added as an external project in CMake. |
opae-sim | Contains simulation projects like ASE. | Added as an external project in CMake. |
opae-test | Contains mock framework for unit tests. | Added as an external project in CMake. |
- Removed Safe String module dependency
- Removed pybind11 3rd component from OPAE source repository. pybind11 is now dynamically loaded
- Ported python tools to python3.6
Notes / Known Issues
- This release supports FPGA driver that has been upstreamed to the Linux Kernel 5.6 as of March, 2020. The driver does not support all FPGA features available on Intel(R) PAC with Arria(R) 10 GX FPGA cards or Intel® FPGA Programmable Acceleration Card N3000 cards.
opae-sdk-1.4.0
Open Programmable Acceleration Engine (OPAE) is a software framework for managing and accessing programmable accelerators (FPGAs). Its main parts are:
-
OPAE Software Development Kit (OPAE SDK),
-
OPAE Linux driver for Intel(R) Xeon(R) CPU with Integrated FPGAs and Intel(R) PAC with Arria(R) 10 GX FPGA
-
Basic Building Block (BBB) library for accelerating AFU
development (not part of this release, but pre-release code is
available on GitHub: https://github.com/OPAE/intel-fpga-bbb
OPAE is under active development to extend to more hardware platforms, as well as to build up the software stack with additional abstractions to enable more software developers.
OPAE SDK is a collection of libraries and tools to facilitate the development of software applications and accelerators using OPAE. It provides a library implementing the OPAE C API for presenting a streamlined and easy-to-use interface for software applications to discover, access, and manage FPGA devices and accelerators using the OPAE software stack. The OPAE SDK also includes the AFU Simulation Environment (ASE) for end-to-end simulation of accelerator RTL together with software applications using the OPAE C API.
OPAE's goal is to accelerate FPGA adoption. It is a community effort to simplify the development and deployment of FPGA applications, so we explicitly welcome discussions and contributions! The OPAE SDK source, unless otherwise noted, is released under a BSD 3-clause license.
More information about OPAE can be found
at http://01.org/OPAE.
Open Programmable Acceleration Engine (OPAE) 1.4.0 Release Notes
This document provides the Release Notes for the Open Programmable
Acceleration Engine (OPAE) 1.4.0 release.
System Compatibility
-
Hardware: tightly coupled FPGA products and programmable FPGA
acceleration cards for Intel(R) Xeon(R) processors:- Intel(R) PAC with Arria(R) 10 GX FPGA (PCI ID: 0x09c4) FIM version 1.1.2-1 (1.2 Production)
- Intel(R) Xeon with Integrated FPGA (PCI ID: 0xbcc0) FIM version 6.4.0
- Intel® FPGA Programmable Acceleration Card N3000 (PCI ID: 0x0b30) FIM version D.1.0.13 (1.0 Production)
-
Operating System: Tested on RedHat 7.6, CentOS 7.6 with Linux Kernel 3.10 and the community 4.19 LTS kernels.
Major Changes from 1.3.0 to 1.4.0
-
Added support to FPGA Linux kernel Device Feature List (DFL) driver patch set2.
-
Added test cases and Increased test coverage
-
Various bug fixes
-
Various memory leak fixes
-
Various Static code scan bug fixes
-
Added new FPGA MMIO API to write 512 bits
-
OPAE 1.4.0 may not be compatible with other versions of Linux OS/Kernel
-
OPAE & Intel FPGA driver are tested on Intel Programmable Acceleration Card Arria 10 GX FPGA & Intel PAC N3000.
-
OPAE & DFL FPGA driver are tested on Intel Programmable Acceleration Card Arria 10 GX FPGA.
-
FPGA DFL Linux driver source code patchset2 available in Linux 5.4 kernel
Notes / Known Issues
-
In addition to supporting the OPAE driver bundled with OPAE SDK releases, the OPAE SDK libraries now
support the FPGA driver that has been upstreamed to the Linux Kernel 5.4.
For more details on this, please see the OPAE documentation related to this. -
DFL FPGA driver patchset2 doesn’t support all the features supported by Intel FPGA driver.
-
FPGAInfo tool doesn’t clear injected error.
-
Partial reconfiguration with SR-IOV
-
If using OPAE in a virtualized environment with SR-IOV enabled, we recommend disabling SR-IOV before performing partial reconfiguration. See "Partial Reconfiguration" in the "OPAE Intel FPGA Linux Device Driver Architecture" document for more information
-
Driver may not display explicit incompatibility message if loaded on mismatched FIM version
When trying to insert the Linux kernel driver modules while an FPGA platform with an unsupported FIM version is present in the system, the driver may fail to load and/or fail to print an explicit incompatibility warning message in the system log. Please make sure to use the driver only with a compatible FIM.
-
ASE: Multiple ModelSim simulator instances may crash when run on the same host
When trying to run multiple instances of the ModelSim simulator on a single system, the simulator may crash. Only run one instance of ModelSim at the same time per system.
opae-sdk-1.3.6-VC
OPAE SDK 1.3.6-VC supports Intel® FPGA Programmable Acceleration Card N3000 Version 1.1 production release.
The package includes the same OPAE SW components that are publicly available on Intel Acceleration Download site.
https://www.intel.com/content/www/us/en/programmable/products/boards_and_kits/dev-kits/altera/intel-fpga-pac-n3000/getting-started.html
Intel® FPGA Programmable Acceleration Card N3000 Version 1.1 documents including User Guide and Production Release Notes are available here:
https://www.intel.com/content/www/us/en/programmable/products/boards_and_kits/dev-kits/altera/intel-fpga-pac-n3000/documentation.html