LIMITATIONS.md, BUILD.md: cleanup and clarifications

Change-Id: Ibe18647c61a1410337bb9aade4a349c61ddb778b
This commit is contained in:
Cetnerowski, Adam
2018-02-20 12:37:45 +01:00
committed by sys_ocldev
parent 5c7e50df48
commit 2ed68b341e
2 changed files with 35 additions and 12 deletions

View File

@@ -4,7 +4,7 @@
*Instructions assume clean Ubuntu* 16.04.3 LTS installation.*
1. Download & install required dependencies
1. Download & install required dependencies
Example:
@@ -12,6 +12,8 @@ Example:
sudo apt-get install ccache flex bison clang-4.0 cmake g++ git patch zlib1g-dev
```
See [LIMITATIONS.md](https://github.com/intel/compute-runtime/blob/master/documentation/LIMITATIONS.md) for other requirements and dependencies, when building and installing NEO.
2. Create workspace folder and download sources:
```
workspace
@@ -72,5 +74,4 @@ Example:
sudo dpkg -i intel-opencl-1.0-0.x86_64-igdrcl.deb
```
___(*) Other names and brands my be claimed as property of others.___
___(*) Other names and brands my be claimed as property of others.___

View File

@@ -5,29 +5,51 @@
OpenCL compliance of a driver built from open-source components should not be
assumed by default. Intel will clearly designate / tag specific builds to
indicate production quality including formal compliance. Other builds should be
considered experimental.
considered experimental.
### Build limitations
While NEO can be compiled with various clang/gcc compilers, to compile the whole stack the following are required:
* clang-4.0
* llvm-4.0
* gcc < 7.0
* Python 2.7
### ICD Loader
The driver requires Khronos ICD loader to operate correctly:
https://github.com/KhronosGroup/OpenCL-ICD-Loader
When building NEO, you will get a warning (build will continue), if source code for this repository is missing in your workspace.
Workaround:
If ocl-icd package (version >= 2.2.11) is installed (or included in distribution), set environment variable OCL_ICD_ASSUME_ICD_EXTENSION=1
### Functional delta
The driver has the following functional delta compared to previously released drivers:
* Intel's closed source SRB5.0 driver (aka Classic)
* Intel's closed source SRB5.0 driver (aka Classic)
https://software.intel.com/en-us/articles/opencl-drivers#latest_linux_driver
* Intel's former open-source Beignet driver
* Intel's former open-source Beignet driver
https://01.org/beignet
### Generic extensions
#### Generic extensions
* cl_khr_mipmap
* cl_khr_mipmap_writes
* cl_khr_fp64
### Preview extensions
_Currently under development_
#### Preview extensions
* cl_intelx_video_enhancement
* cl_intelx_video_enhancement_camera_pipeline
* cl_intelx_video_enhancement_color_pipeline
* cl_intelx_hevc_pak
### Other capabilities
* OpenGL sharing with MESA driver
* CL_MEM_SVM_FINE_GRAIN_BUFFER (if using unpatched i915)
_Currently no plan to implement. If interested in these features, please use SRB5 to evaluate and provide feedback._
#### Other capabilities
* OpenGL sharing with MESA driver - _will implement in the future (no specific timeline)_
* CL_MEM_SVM_FINE_GRAIN_BUFFER (if using unpatched i915) - _patch is WIP_
___(*) Other names and brands my be claimed as property of others.___