Skip to content

Commit c9c71ba

Browse files
aviralniaviralni
committed
doc: Add Linux and Windows dependency columns to pyzes README
Add Linux Dependencies and Windows Dependencies columns to the SUPPORTED APIs table that list the external libraries the Level Zero driver needs at runtime on each OS for each API: libigsc, libudev, libnl-genl-3 and libtracefs on Linux, igsc.dll on Windows. Also add the missing row for zesDeviceGetSubDevicePropertiesExp. Related-To: SYSM-473 Signed-off-by: Aviral Nigam <aviral.nigam@intel.com>
1 parent 1b53fac commit c9c71ba

1 file changed

Lines changed: 101 additions & 91 deletions

File tree

‎bindings/sysman/python/README.md‎

Lines changed: 101 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -159,97 +159,107 @@ All meaningful constants and enums are exposed in Python module.
159159
SUPPORTED APIs
160160
--------------
161161

162-
| API Function | Module | Since Version | Limitations |
163-
|--------------|--------|---------------|-------------|
164-
| `zesInit` | Device | 0.1.0 | None |
165-
| `zesDriverGet` | Device | 0.1.0 | None |
166-
| `zesDeviceGet` | Device | 0.1.0 | None |
167-
| `zesDeviceGetProperties` | Device | 0.1.0 | None |
168-
| `zesDriverGetDeviceByUuidExp` | Device | 0.1.0 | Experimental API |
169-
| `zesDeviceProcessesGetState` | Device | 0.1.0 | None |
170-
| **Driver Management** |-|-|-|
171-
| `zesDriverGetProperties` | Driver | 0.1.4 | None |
172-
| `zesDriverGetExtensionProperties` | Driver | 0.1.4 | None |
173-
| `zesDriverGetExtensionFunctionAddress` | Driver | 0.1.4 | Returns a raw function address |
174-
| `zesDriverEventListenEx` | Driver | 0.1.4 | Linux: Requires superuser |
175-
| `zesDriverEventRegisterExt` | Driver | 0.1.4 | None |
176-
| `zesDriverEventListenExt` | Driver | 0.1.4 | Linux: Requires superuser |
177-
| `zesDeviceGetState` | Device | 0.1.4 | None |
178-
| `zesDeviceResetExt` | Device | 0.1.4 | Linux: Requires superuser; all device state is lost |
179-
| `zesDeviceEventRegister` | Device | 0.1.4 | Linux: Requires superuser |
180-
| `zesDeviceGetHealthStatusExt` | Device | 0.1.4 | None |
181-
| `zesDeviceSetHealthStatusExt` | Device | 0.1.4 | Linux: Requires superuser; persisted to non-volatile memory |
182-
| `zesDeviceEnumFirmwares` | Device | 0.1.4 | None |
183-
| `zesFirmwareGetProperties` | Firmware | 0.1.4 | None |
184-
| **Memory Management** |-|-|-|
185-
| `zesDeviceEnumMemoryModules` | Memory | 0.1.0 | None |
186-
| `zesMemoryGetProperties` | Memory | 0.1.0 | None |
187-
| `zesMemoryGetState` | Memory | 0.1.0 | None |
188-
| `zesMemoryGetBandwidth` | Memory | 0.1.0 | Linux: Requires superuser or read permissions for telem nodes |
189-
| **Power Management** |-|-|-|
190-
| `zesDeviceEnumPowerDomains` | Power | 0.1.0 | None |
191-
| `zesPowerGetEnergyCounter` | Power | 0.1.0 | Linux: Requires superuser or read permissions for telem nodes |
192-
| `zesPowerGetProperties` | Power | 0.1.2 | None |
193-
| `zesPowerGetLimitsExt` | Power | 0.1.2 | Extended power limits API |
194-
| `zesPowerSetLimitsExt` | Power | 0.1.2 | Linux: Requires superuser or write permissions for telem nodes |
195-
| `zesPowerGetUsage` | Power | 0.1.4 | Linux: Requires superuser or read permissions for telem nodes |
196-
| `zesPowerGetLimitsExt2` | Power | 0.1.4 | None |
197-
| `zesPowerSetLimitsExt2` | Power | 0.1.4 | Linux: Requires superuser |
198-
| `zesPowerGetEnergyThreshold` | Power | 0.1.4 | None |
199-
| `zesPowerSetEnergyThreshold` | Power | 0.1.4 | Linux: Requires superuser |
200-
| **Frequency Management** |-|-|-|
201-
| `zesDeviceEnumFrequencyDomains` | Frequency | 0.1.0 | None |
202-
| `zesFrequencyGetState` | Frequency | 0.1.0 | None |
203-
| `zesFrequencyGetProperties` | Frequency | 0.1.2 | None |
204-
| `zesFrequencyGetAvailableClocks` | Frequency | 0.1.2 | None |
205-
| `zesFrequencyGetRange` | Frequency | 0.1.2 | None |
206-
| `zesFrequencySetRange` | Frequency | 0.1.2 | Linux: Requires superuser or write permissions for telem nodes |
207-
| `zesFrequencyGetThrottleTime` | Frequency | 0.1.2 | None |
208-
| **Temperature Monitoring** |-|-|-|
209-
| `zesDeviceEnumTemperatureSensors` | Temperature | 0.1.0 | None |
210-
| `zesTemperatureGetProperties` | Temperature | 0.1.0 | None |
211-
| `zesTemperatureGetConfig` | Temperature | 0.1.0 | None |
212-
| `zesTemperatureGetState` | Temperature | 0.1.0 | Linux: Requires superuser or read permissions for telem nodes |
213-
| `zesTemperatureSetConfig` | Temperature | 0.1.4 | Linux: Requires superuser |
214-
| **Engine Management** |-|-|-|
215-
| `zesDeviceEnumEngineGroups` | Engine | 0.1.0 | Linux: Shows "no handles found" error when not in superuser mode |
216-
| `zesEngineGetProperties` | Engine | 0.1.0 | None |
217-
| `zesEngineGetActivity` | Engine | 0.1.0 | None |
218-
| `zesEngineGetActivityExt` | Engine | 0.1.4 | None |
219-
| **Standby Management** |-|-|-|
220-
| `zesDeviceEnumStandbyDomains` | Standby | 0.1.4 | None |
221-
| `zesStandbyGetProperties` | Standby | 0.1.4 | None |
222-
| `zesStandbyGetMode` | Standby | 0.1.4 | None |
223-
| `zesStandbySetMode` | Standby | 0.1.4 | Linux: Requires superuser |
224-
| **Virtual Function (VF) Management** |-|-|-|
225-
| `zesDeviceEnumEnabledVFExp` | VF Management | 0.1.4 | Experimental API |
226-
| `zesVFManagementGetVFCapabilitiesExp2` | VF Management | 0.1.4 | Experimental API |
227-
| `zesVFManagementGetVFEngineUtilizationExp2` | VF Management | 0.1.4 | Experimental API. Linux: Requires superuser |
228-
| `zesVFManagementGetVFMemoryUtilizationExp2` | VF Management | 0.1.4 | Experimental API |
229-
| **PCI Management** |-|-|-|
230-
| `zesDevicePciGetProperties` | PCI | 0.1.2 | Linux: Requires superuser or read permissions for telem nodes |
231-
| `zesDevicePciGetState` | PCI | 0.1.2 | Linux: Requires superuser or read permissions for telem nodes |
232-
| `zesDevicePciGetStats` | PCI | 0.1.2 | Linux: Requires superuser or read permissions for telem nodes |
233-
| **ECC (Error Correction Code) Management** |-|-|-|
234-
| `zesDeviceEccAvailable` | ECC | 0.1.2 | None |
235-
| `zesDeviceEccConfigurable` | ECC | 0.1.2 | None |
236-
| `zesDeviceGetEccState` | ECC | 0.1.2 | None |
237-
| `zesDeviceSetEccState` | ECC | 0.1.2 | None |
238-
| **RAS (Reliability, Availability, Serviceability)** |-|-|-|
239-
| `zesDeviceEnumRasErrorSets` | RAS | 0.1.4 | Linux: Requires superuser |
240-
| `zesRasGetProperties` | RAS | 0.1.4 | None |
241-
| `zesRasGetSupportedCategoriesExp` | RAS | 0.1.4 | Experimental API |
242-
| `zesRasGetStateExp2` | RAS | 0.1.4 | Experimental API. Linux: Requires superuser |
243-
| `zesRasGetConfigExp` | RAS | 0.1.4 | Experimental API. Linux: Requires superuser |
244-
| `zesRasSetConfigExp` | RAS | 0.1.4 | Experimental API. Linux: Requires superuser |
245-
| `zesRasClearStateExp` | RAS | 0.1.4 | Experimental API. Linux: Requires superuser |
246-
| **Info Log Management** |-|-|-|
247-
| `zesDriverEnumInfoLogsExt` | Info Log | 0.1.4 | Linux: Requires superuser |
248-
| `zesInfoLogGetPropertiesExt` | Info Log | 0.1.4 | None |
249-
| `zesInfoLogCreateInstanceExt` | Info Log | 0.1.4 | Linux: Requires superuser |
250-
| `zesInfoLogInstanceReadWithMetadataExt` | Info Log | 0.1.4 | Records returned are consumed. Linux: Requires superuser |
251-
| `zesInfoLogInstancePeekWithMetadataExt` | Info Log | 0.1.4 | Linux: Requires superuser |
252-
| `zesInfoLogInstanceDeleteExt` | Info Log | 0.1.4 | Linux: Requires superuser |
162+
The Linux Dependencies and Windows Dependencies columns list the external libraries that the Level Zero driver needs at runtime on that OS to support the API. Which of them is used depends on the platform.
163+
- Linux:
164+
- `libigsc`: libigsc.so.1 or libigsc.so.0
165+
- `libudev`: libudev.so.1
166+
- `libnl-genl-3`: libnl-genl-3.so.200
167+
- `libtracefs`: libtracefs.so.1, version 1.8.0 or newer
168+
- Windows:
169+
- `igsc.dll`
170+
171+
| API Function | Module | Since Version | Limitations | Linux Dependencies | Windows Dependencies |
172+
|--------------|--------|---------------|-------------|--------------------|----------------------|
173+
| `zesInit` | Device | 0.1.0 | None | None | None |
174+
| `zesDriverGet` | Device | 0.1.0 | None | None | None |
175+
| `zesDeviceGet` | Device | 0.1.0 | None | None | None |
176+
| `zesDeviceGetProperties` | Device | 0.1.0 | None | None | None |
177+
| `zesDriverGetDeviceByUuidExp` | Device | 0.1.0 | Experimental API | None | None |
178+
| `zesDeviceGetSubDevicePropertiesExp` | Device | 0.1.0 | Experimental API | None | None |
179+
| `zesDeviceProcessesGetState` | Device | 0.1.0 | None | None | None |
180+
| **Driver Management** |-|-|-|-|-|
181+
| `zesDriverGetProperties` | Driver | 0.1.4 | None | None | None |
182+
| `zesDriverGetExtensionProperties` | Driver | 0.1.4 | None | None | None |
183+
| `zesDriverGetExtensionFunctionAddress` | Driver | 0.1.4 | Returns a raw function address | None | None |
184+
| `zesDriverEventListenEx` | Driver | 0.1.4 | Linux: Requires superuser | `libudev`, `libnl-genl-3` | None |
185+
| `zesDriverEventRegisterExt` | Driver | 0.1.4 | None | None | None |
186+
| `zesDriverEventListenExt` | Driver | 0.1.4 | Linux: Requires superuser | `libudev`, `libnl-genl-3`, `libtracefs` | None |
187+
| `zesDeviceGetState` | Device | 0.1.4 | None | `libigsc` | None |
188+
| `zesDeviceResetExt` | Device | 0.1.4 | Linux: Requires superuser; all device state is lost | None | None |
189+
| `zesDeviceEventRegister` | Device | 0.1.4 | Linux: Requires superuser | None | None |
190+
| `zesDeviceGetHealthStatusExt` | Device | 0.1.4 | None | None | None |
191+
| `zesDeviceSetHealthStatusExt` | Device | 0.1.4 | Linux: Requires superuser; persisted to non-volatile memory | None | None |
192+
| `zesDeviceEnumFirmwares` | Device | 0.1.4 | None | `libigsc` | `igsc.dll` |
193+
| `zesFirmwareGetProperties` | Firmware | 0.1.4 | None | `libigsc` | `igsc.dll` |
194+
| **Memory Management** |-|-|-|-|-|
195+
| `zesDeviceEnumMemoryModules` | Memory | 0.1.0 | None | None | None |
196+
| `zesMemoryGetProperties` | Memory | 0.1.0 | None | None | None |
197+
| `zesMemoryGetState` | Memory | 0.1.0 | None | `libigsc` | None |
198+
| `zesMemoryGetBandwidth` | Memory | 0.1.0 | Linux: Requires superuser or read permissions for telem nodes | None | None |
199+
| **Power Management** |-|-|-|-|-|
200+
| `zesDeviceEnumPowerDomains` | Power | 0.1.0 | None | None | None |
201+
| `zesPowerGetEnergyCounter` | Power | 0.1.0 | Linux: Requires superuser or read permissions for telem nodes | None | None |
202+
| `zesPowerGetProperties` | Power | 0.1.2 | None | None | None |
203+
| `zesPowerGetLimitsExt` | Power | 0.1.2 | Extended power limits API | None | None |
204+
| `zesPowerSetLimitsExt` | Power | 0.1.2 | Linux: Requires superuser or write permissions for telem nodes | None | None |
205+
| `zesPowerGetUsage` | Power | 0.1.4 | Linux: Requires superuser or read permissions for telem nodes | None | None |
206+
| `zesPowerGetLimitsExt2` | Power | 0.1.4 | None | None | None |
207+
| `zesPowerSetLimitsExt2` | Power | 0.1.4 | Linux: Requires superuser | None | None |
208+
| `zesPowerGetEnergyThreshold` | Power | 0.1.4 | None | None | None |
209+
| `zesPowerSetEnergyThreshold` | Power | 0.1.4 | Linux: Requires superuser | None | None |
210+
| **Frequency Management** |-|-|-|-|-|
211+
| `zesDeviceEnumFrequencyDomains` | Frequency | 0.1.0 | None | None | None |
212+
| `zesFrequencyGetState` | Frequency | 0.1.0 | None | None | None |
213+
| `zesFrequencyGetProperties` | Frequency | 0.1.2 | None | None | None |
214+
| `zesFrequencyGetAvailableClocks` | Frequency | 0.1.2 | None | None | None |
215+
| `zesFrequencyGetRange` | Frequency | 0.1.2 | None | None | None |
216+
| `zesFrequencySetRange` | Frequency | 0.1.2 | Linux: Requires superuser or write permissions for telem nodes | None | None |
217+
| `zesFrequencyGetThrottleTime` | Frequency | 0.1.2 | None | None | None |
218+
| **Temperature Monitoring** |-|-|-|-|-|
219+
| `zesDeviceEnumTemperatureSensors` | Temperature | 0.1.0 | None | None | None |
220+
| `zesTemperatureGetProperties` | Temperature | 0.1.0 | None | None | None |
221+
| `zesTemperatureGetConfig` | Temperature | 0.1.0 | None | None | None |
222+
| `zesTemperatureGetState` | Temperature | 0.1.0 | Linux: Requires superuser or read permissions for telem nodes | None | None |
223+
| `zesTemperatureSetConfig` | Temperature | 0.1.4 | Linux: Requires superuser | None | None |
224+
| **Engine Management** |-|-|-|-|-|
225+
| `zesDeviceEnumEngineGroups` | Engine | 0.1.0 | Linux: Shows "no handles found" error when not in superuser mode | None | None |
226+
| `zesEngineGetProperties` | Engine | 0.1.0 | None | None | None |
227+
| `zesEngineGetActivity` | Engine | 0.1.0 | None | None | None |
228+
| `zesEngineGetActivityExt` | Engine | 0.1.4 | None | None | None |
229+
| **Standby Management** |-|-|-|-|-|
230+
| `zesDeviceEnumStandbyDomains` | Standby | 0.1.4 | None | None | None |
231+
| `zesStandbyGetProperties` | Standby | 0.1.4 | None | None | None |
232+
| `zesStandbyGetMode` | Standby | 0.1.4 | None | None | None |
233+
| `zesStandbySetMode` | Standby | 0.1.4 | Linux: Requires superuser | None | None |
234+
| **Virtual Function (VF) Management** |-|-|-|-|-|
235+
| `zesDeviceEnumEnabledVFExp` | VF Management | 0.1.4 | Experimental API | None | None |
236+
| `zesVFManagementGetVFCapabilitiesExp2` | VF Management | 0.1.4 | Experimental API | None | None |
237+
| `zesVFManagementGetVFEngineUtilizationExp2` | VF Management | 0.1.4 | Experimental API. Linux: Requires superuser | None | None |
238+
| `zesVFManagementGetVFMemoryUtilizationExp2` | VF Management | 0.1.4 | Experimental API | None | None |
239+
| **PCI Management** |-|-|-|-|-|
240+
| `zesDevicePciGetProperties` | PCI | 0.1.2 | Linux: Requires superuser or read permissions for telem nodes | None | None |
241+
| `zesDevicePciGetState` | PCI | 0.1.2 | Linux: Requires superuser or read permissions for telem nodes | None | None |
242+
| `zesDevicePciGetStats` | PCI | 0.1.2 | Linux: Requires superuser or read permissions for telem nodes | None | None |
243+
| **ECC (Error Correction Code) Management** |-|-|-|-|-|
244+
| `zesDeviceEccAvailable` | ECC | 0.1.2 | None | `libigsc` | `igsc.dll` |
245+
| `zesDeviceEccConfigurable` | ECC | 0.1.2 | None | `libigsc` | `igsc.dll` |
246+
| `zesDeviceGetEccState` | ECC | 0.1.2 | None | `libigsc` | `igsc.dll` |
247+
| `zesDeviceSetEccState` | ECC | 0.1.2 | None | `libigsc` | `igsc.dll` |
248+
| **RAS (Reliability, Availability, Serviceability)** |-|-|-|-|-|
249+
| `zesDeviceEnumRasErrorSets` | RAS | 0.1.4 | Linux: Requires superuser | `libnl-genl-3`, `libigsc` | None |
250+
| `zesRasGetProperties` | RAS | 0.1.4 | None | `libnl-genl-3`, `libigsc` | None |
251+
| `zesRasGetSupportedCategoriesExp` | RAS | 0.1.4 | Experimental API | `libnl-genl-3`, `libigsc` | None |
252+
| `zesRasGetStateExp2` | RAS | 0.1.4 | Experimental API. Linux: Requires superuser | `libnl-genl-3`, `libigsc` | None |
253+
| `zesRasGetConfigExp` | RAS | 0.1.4 | Experimental API. Linux: Requires superuser | `libnl-genl-3` | None |
254+
| `zesRasSetConfigExp` | RAS | 0.1.4 | Experimental API. Linux: Requires superuser | `libnl-genl-3` | None |
255+
| `zesRasClearStateExp` | RAS | 0.1.4 | Experimental API. Linux: Requires superuser | `libnl-genl-3`, `libigsc` | None |
256+
| **Info Log Management** |-|-|-|-|-|
257+
| `zesDriverEnumInfoLogsExt` | Info Log | 0.1.4 | Linux: Requires superuser | None | None |
258+
| `zesInfoLogGetPropertiesExt` | Info Log | 0.1.4 | None | None | None |
259+
| `zesInfoLogCreateInstanceExt` | Info Log | 0.1.4 | Linux: Requires superuser | `libtracefs` | None |
260+
| `zesInfoLogInstanceReadWithMetadataExt` | Info Log | 0.1.4 | Records returned are consumed. Linux: Requires superuser | `libtracefs` | None |
261+
| `zesInfoLogInstancePeekWithMetadataExt` | Info Log | 0.1.4 | Linux: Requires superuser | `libtracefs` | None |
262+
| `zesInfoLogInstanceDeleteExt` | Info Log | 0.1.4 | Linux: Requires superuser | `libtracefs` | None |
253263

254264
RELEASE NOTES
255265
-------------

0 commit comments

Comments
 (0)