README.rst
1
2Intel(R) Graphics Memory Management Library
3*******************************************
4
5Introduction
6=============
7
8The Intel(R) Graphics Memory Management Library provides device specific and buffer
9management for the Intel(R) Graphics Compute Runtime for OpenCL(TM) and the
10Intel(R) Media Driver for VAAPI.
11
12License
13========
14
15The Intel(R) Graphics Memory Management Library is distributed under the MIT
16Open Source license.
17
18You may obtain a copy of the License at:
19
20https://opensource.org/licenses/MIT
21
22Building
23========
241) Get gmmlib repository
25
26 git clone https://github.com/intel/gmmlib.git
27
282) Change it to root directory
29
30 ``$ cd gmmlib``
31
323) Make a build directory
33
34 ``$ mkdir build && cd build``
35
364) Run the cmake command to prepare build files
37
38| ``$ cmake [-DCMAKE_BUILD_TYPE=Release | Debug | ReleaseInternal] ..``
39| where,
40| -DCMAKE_BUILD_TYPE can be set to one build type flag at a time.
41| Example:
42| ``$ cmake -DCMAKE_BUILD_TYPE=Release ..``, For Release build
43
445) Build the project
45
46 ``$ make -j"$(nproc)" (Also performs compile time ULT)``
47
48Install
49=======
50``$ sudo make install``
51
52This will install the following files (e.g. on Ubuntu):
53
54| -- Install configuration: "Release"
55| -- Installing: /usr/local/lib/libigdgmm.so.12.1.0
56| -- Installing: /usr/local/lib/libigdgmm.so.12
57|
58
59
60Not a stand alone software component.
61GmmLib is built as dynamic library for Intel media driver and Compute runtime for OpenCL
62
63Supported Platforms
64-------------------
65Intel Atom and Core Processors supporting Gen8/Gen9/Gen10 graphics devices
66
67BDW (Broadwell)
68
69SKL (Skylake, Kaby Lake, Coffee Lake)
70
71BXTx (BXT: Broxton, APL: Apollo Lake, GLK: Gemini Lake)
72
73KBLx (KBL: Kaby Lake, CFL: Coffe Lake, WHL: Whiskey Lake, CML: Comet Lake, AML: Amber Lake)
74
75CNL (Cannonlake)
76
77ICL (Icelake)
78
79TGLx (TGL: Tiger Lake, RKL: Rocket Lake)
80
81ADLx (ADL-S: Alder Lake S, ADL-P: Alder Lake P, ADL-N: Alder Lake N)
82
83XE_LP (DG1)
84
85XE_HP (XE_HP_SDV)
86
87XE_HPC (PVC: Ponte Vecchio)
88
89XE_HPG (DG2, ACM: Alchemist)
90
91Xe_LPG (MTL: Meteor Lake, ARL: Arrow Lake)
92
93Xe2_HPG (BMG: Battlemage, LNL: Lunar Lake)
94
95Release Tags
96============
97
98Gmmlib Release tag versioning schema follows:
99
100| Tag ``intel-gmmlib-<x>.<y>.<z>`` will be stable release series with the same API and ABI version with only bug fixes where,
101| x = GMMLIB_API_MAJOR_VERSION + 10,
102| y = GMMLIB_API_MINOR_VERSION,
103| z = RELEASE NUMBER which is incremented as 0,1,2,...n for changes including new flag, bug fixes, etc.
104|
105| Example:
106| For GMM library ``libigdgmm.so.12.0.0``,
107| Tag = ``intel-gmmlib-22.0.0`` where,
108| 22 = GMMLIB_API_MAJOR_VERSION + 10 = 12 + 10
109| 0 = GMMLIB_API_MINOR_VERSION
110| 0 = RELEASE NUMBER
111|
112On potential ABI break changes,
113
114| Tag ``intel-gmmlib-<x>.<y>.<z>`` becomes ``intel-gmmlib-<x + 1>.0.0``
115| i.e ``intel-gmmlib-22.5.3`` becomes ``intel-gmmlib-23.0.0``
116
117Known Issues and Limitations
118============================
119Current Gmmlib support only limited to Linux
120
121(*) Other names and brands may be claimed as property of others.
122---------------------------------------------------------------
123
124