opae: update 1.4.0 release notes (#1400)

RELEASE_NOTES.md

@@ -17,115 +17,62 @@ OPAE\'s goal is to accelerate FPGA adoption. It is a community effort to simplif
 More information about OPAE can be found
 at http://01.org/OPAE.
 
-Open Programmable Acceleration Engine (OPAE) 1.3.0 Release Notes
+Open Programmable Acceleration Engine (OPAE) 1.4.0 Release Notes
 -----------------------------------------------------------------
 
 This document provides the Release Notes for the Open Programmable
-Acceleration Engine (OPAE) 1.3.0 release.
+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.0.3 (1.0 Production)
+    - 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 Red Hat Enterprise Linux 7.3 and 7.4, Ubuntu 16.04, 
-    SUSE SLE 12 SP3 and CentOS 7.4, with Linux kernels 3.10 through 4.7
+-   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.2.0 to 1.3.0
+Major Changes from 1.3.0 to 1.4.0
 ----------------------------------
 
-- Updated python requests package used by Sphinx
-- Updated fpgad to enumerate for supported devices discarding the previous assumption that it is running on a dual-socket integrated FPGA platform
-- Added Python version of fpgamux
-- Added deprecation notice for legacy C++ API
-- Updated default installation location for packages generated through CMake to "/usr" instead of "/usr/local"
-- Added support to FPGA Linux kernel Device Feature List (DFL) driver patch set 1. (see Notes below for more information)
-- Increased test cases and test coverage
-- Cleaned up dead/legacy code
-- Various bug fixes
-- Various compiler warning fixes
-- Various memory leak fixes
-
-Major Changes from 1.3.2 to 1.4.0
-----------------------------------
 - Added support to FPGA Linux kernel Device Feature List (DFL) driver patch set2.
-- Increased test cases and test coverage
+- Added test cases and Increased test coverage
 - Various bug fixes
-- Various compiler warning fixes
 - Various memory leak fixes
 - Various Static code scan bug fixes
 - Added new FPGA MMIO API to write 512 bits
 
-Notes / Known Issues
---------------------
--  libopaec++ is being deprecated in favor of the official OPAE C++ API.
-While no tools in the OPAE codebase use libopaec++, the code is being kept here
-for any other tools that may use it outside of the OPAE repository.
-This directory, however, will be removed in future versions of OPAE.
-For more information and reference on the official API, see the
-[documentation](https://opae.github.io/latest/docs/fpga_api/fpga_cxx_api.html).
-
--   fpgamux has been ported to use the OPAE Python API.
-
--   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 4.18.
-For more details on this, please see the [OPAE documentation](https://opae.github.io/1.3.0/docs/fpga_dfl_drv/fpga_dfl_drv.html) related to this.
-
--   Seldom in stress tests, kernel panic may be encountered in kernel version 3.10. Preliminary debug information seems to indicate it may be related to hugepage support in the Linux kernel.
-
--   The current Python distributions included in this release are
-    -  opae.fpga-1.3.0.tar.gz - The source files for building the Python bindings. This requires OPAE development package to be installed prior to building
-    -  opae.fpga-1.3.0-cp27-cp27mu-linux_x86_64.whl - A binary package built with Python 2.7
-    -  opae.fpga-1.3.0-cp34-cp34m-linux_x86_64.whl - A binary package built with Python 3.4
-    -  opae.fpga-1.3.0-cp35-cp35m-linux_x86_64.whl - A binary package built with Python 3.5
+- 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.
 
--   A different OPN is used in the design examples
+- OPAE & DFL FPGA driver are tested on Intel Programmable Acceleration Card Arria 10 GX FPGA.
 
-    The Intel Quartus Prime Pro Edition license uses a design example
+- FPGA DFL Linux driver source code patchset2 available in Linux 5.4 kernel
+   - https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/tree/drivers?h=linux-5.4.y
 
-    OPN of 10AX115N3F40E2SG, instead of the Intel PAC with Intel Arria
-    10 GX FPGA OPN of 10AX115N2F40E2LG. This difference does not impact
-    your design.
 
--   PCIe directed speed changes are not supported
-
-    Only automatic down-training at boot time is supported
+Notes / Known Issues
+--------------------
 
--   Virtual Function (VF) may fail to attach or detach when using the
-    Linux Red Hat 3.10 kernel
-
-    This is a known issue with qemu/kvm and libvirt. Refer to the Red
-    Hat website for more information about this issue.
+- 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](https://opae.github.io/1.4.0/docs/fpga_dfl_drv/fpga_dfl_drv.html) related to this.
 
--   The Intel FPGA Dynamic Profiler Tool for OpenCL GUI reports
-    frequency and bandwidth incorrectly
+- DFL FPGA driver patchset2 doesn’t support all the features supported by Intel FPGA driver.
 
-    This issue will be resolved in a future version of the Intel
-    Acceleration Stack.
+- 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
-
-- fpgaAssignToInterface() and fpgaReleaseFromInterface() not supported
-
-  The OPAE C API provides functions to assign individual AFCs to host interfaces (i.e. a virtual or physical function). Due to the internal implementation of fpga_token, these functions are not yet supported. Instead, we provide a simplified call fpgaAssignPortToInterface() that can assign a port by number to either the physical function (PF) or virtual function (VF). This function will eventually be replaced by the more generic implementation of fpgaAssignToInterface() and fpgaReleaseFromInterface() in a future release.
-
-
-- AP6 condition may prevent clearing of port errors
-
-  If the system encounters an AP6 condition (exceeded power or temperature threshold), it will report a port error. These errors can only be cleared (e.g. using fpgainfo) after the AP6 condition has been removed.
+- 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.
+    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.
-
-