Power - Deprecated

oneAPI Level Zero Specification - Version 1.20.41

Power - Deprecated Functions

zesPowerGetLimits

Added in version 1.0

Deprecated since 1.5. Use zesPowerGetLimitsExt instead.

ZE_APIEXPORT ze_result_t ZE_APICALL zesPowerGetLimits(zes_pwr_handle_t hPower, zes_power_sustained_limit_t *pSustained, zes_power_burst_limit_t *pBurst, zes_power_peak_limit_t *pPeak)

Get power limits

• The application may call this function from simultaneous threads.

• The implementation of this function should be lock-free.

Parameters:

• hPower – [in] Handle for the component.

• pSustained – [in,out][optional] The sustained power limit. If this is null, the current sustained power limits will not be returned.

• pBurst – [in,out][optional] The burst power limit. If this is null, the current peak power limits will not be returned.

• pPeak – [in,out][optional] The peak power limit. If this is null, the peak power limits will not be returned.

Returns:

• ZE_RESULT_SUCCESS

• ZE_RESULT_ERROR_UNINITIALIZED

• ZE_RESULT_ERROR_DEVICE_LOST

• ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY

• ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY

• ZE_RESULT_ERROR_INVALID_ARGUMENT

• ZE_RESULT_ERROR_UNSUPPORTED_FEATURE

• ZE_RESULT_ERROR_DEPENDENCY_UNAVAILABLE

• ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS

• ZE_RESULT_ERROR_NOT_AVAILABLE

• ZE_RESULT_ERROR_DEVICE_REQUIRES_RESET

• ZE_RESULT_ERROR_DEVICE_IN_LOW_POWER_STATE

• ZE_RESULT_ERROR_UNKNOWN

• ZE_RESULT_ERROR_INVALID_NULL_HANDLE

  • nullptr == hPower

zesPowerSetLimits

Added in version 1.0

Deprecated since 1.5. Use zesPowerSetLimitsExt instead.

ZE_APIEXPORT ze_result_t ZE_APICALL zesPowerSetLimits(zes_pwr_handle_t hPower, const zes_power_sustained_limit_t *pSustained, const zes_power_burst_limit_t *pBurst, const zes_power_peak_limit_t *pPeak)

Set power limits

• The application may call this function from simultaneous threads.

• The implementation of this function should be lock-free.

Parameters:

• hPower – [in] Handle for the component.

• pSustained – [in][optional] The sustained power limit. If this is null, no changes will be made to the sustained power limits.

• pBurst – [in][optional] The burst power limit. If this is null, no changes will be made to the burst power limits.

• pPeak – [in][optional] The peak power limit. If this is null, no changes will be made to the peak power limits.

Returns:

• ZE_RESULT_SUCCESS

• ZE_RESULT_ERROR_UNINITIALIZED

• ZE_RESULT_ERROR_DEVICE_LOST

• ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY

• ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY

• ZE_RESULT_ERROR_INVALID_ARGUMENT

• ZE_RESULT_ERROR_UNSUPPORTED_FEATURE

• ZE_RESULT_ERROR_DEPENDENCY_UNAVAILABLE

• ZE_RESULT_ERROR_DEVICE_REQUIRES_RESET

• ZE_RESULT_ERROR_DEVICE_IN_LOW_POWER_STATE

• ZE_RESULT_ERROR_UNKNOWN

• ZE_RESULT_ERROR_INVALID_NULL_HANDLE

  • nullptr == hPower

• ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS

  • User does not have permissions to make these modifications.

• ZE_RESULT_ERROR_NOT_AVAILABLE

  • The device is in use, meaning that the GPU is under Over clocking, applying power limits under overclocking is not supported.

Power - Deprecated Structures

zes_power_sustained_limit_t

Added in version 1.0

Deprecated since 1.8. One descriptor per limit level replaces this struct. Use zes_power_limit_ext_desc_t instead.

struct zes_power_sustained_limit_t

Sustained power limits

• The power controller (Punit) will throttle the operating frequency if the power averaged over a window (typically seconds) exceeds this limit.

Public Members

ze_bool_t enabled

[in,out] indicates if the limit is enabled (true) or ignored (false)

int32_t power

[in,out] power limit in milliwatts

int32_t interval

[in,out] power averaging window (Tau) in milliseconds

zes_power_burst_limit_t

Added in version 1.0

Deprecated since 1.8. One descriptor per limit level replaces this struct. Use zes_power_limit_ext_desc_t instead.

struct zes_power_burst_limit_t

Burst power limit

• The power controller (Punit) will throttle the operating frequency of the device if the power averaged over a few milliseconds exceeds a limit known as PL2. Typically PL2 > PL1 so that it permits the frequency to burst higher for short periods than would be otherwise permitted by PL1.

Public Members

ze_bool_t enabled

[in,out] indicates if the limit is enabled (true) or ignored (false)

int32_t power

[in,out] power limit in milliwatts

zes_power_peak_limit_t

Added in version 1.0

Deprecated since 1.8. One descriptor per limit level replaces this struct. Use zes_power_limit_ext_desc_t instead.

struct zes_power_peak_limit_t

Peak power limit

• The power controller (Punit) will reactively/proactively throttle the operating frequency of the device when the instantaneous/100usec power exceeds this limit. The limit is known as PL4 or Psys. It expresses the maximum power that can be drawn from the power supply.

• If this power limit is removed or set too high, the power supply will generate an interrupt when it detects an overcurrent condition and the power controller will throttle the device frequencies down to min. It is thus better to tune the PL4 value in order to avoid such excursions.

Public Members

int32_t powerAC

[in,out] power limit in milliwatts for the AC power source.

int32_t powerDC

[in,out] power limit in milliwatts for the DC power source. On input, this is ignored if the product does not have a battery. On output, this will be -1 if the product does not have a battery.