Frequency - Deprecated

Frequency - Deprecated#

oneAPI Level Zero Specification - Version 1.20.41

Frequency - Deprecated Functions#

zesFrequencyOcGetCapabilities#

Added in version 1.0

Deprecated since 1.8. Overclocking moved to the Overclock API. Use zesOverclockGetDomainProperties instead.

ZE_APIEXPORT ze_result_t ZE_APICALL zesFrequencyOcGetCapabilities(zes_freq_handle_t hFrequency, zes_oc_capabilities_t *pOcCapabilities)#

Get the overclocking capabilities.

  • The application may call this function from simultaneous threads.

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

Parameters:

  • hFrequency – [in] Handle for the component.

  • pOcCapabilities – [in,out] Pointer to the capabilities structure.

Returns:

zesFrequencyOcGetFrequencyTarget#

Added in version 1.0

Deprecated since 1.8. Overclocking moved to the Overclock API. Use zesOverclockGetControlCurrentValue instead.

ZE_APIEXPORT ze_result_t ZE_APICALL zesFrequencyOcGetFrequencyTarget(zes_freq_handle_t hFrequency, double *pCurrentOcFrequency)#

Get the current overclocking frequency target, if extended moded is supported, will returned in 1 Mhz granularity.

  • The application may call this function from simultaneous threads.

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

Parameters:

  • hFrequency – [in] Handle for the component.

  • pCurrentOcFrequency – [out] Overclocking Frequency in MHz, if extended moded is supported, will returned in 1 Mhz granularity, else, in multiples of 50 Mhz. This cannot be greater than the maxOcFrequency member of zes_oc_capabilities_t.

Returns:

zesFrequencyOcSetFrequencyTarget#

Added in version 1.0

Deprecated since 1.8. Overclocking moved to the Overclock API. Use zesOverclockSetControlUserValue instead.

ZE_APIEXPORT ze_result_t ZE_APICALL zesFrequencyOcSetFrequencyTarget(zes_freq_handle_t hFrequency, double CurrentOcFrequency)#

Set the current overclocking frequency target, if extended moded is supported, can be set in 1 Mhz granularity.

  • The application may call this function from simultaneous threads.

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

Parameters:

  • hFrequency – [in] Handle for the component.

  • CurrentOcFrequency – [in] Overclocking Frequency in MHz, if extended moded is supported, it could be set in 1 Mhz granularity, else, in multiples of 50 Mhz. This cannot be greater than the maxOcFrequency member of zes_oc_capabilities_t.

Returns:

zesFrequencyOcGetVoltageTarget#

Added in version 1.0

Deprecated since 1.8. Overclocking moved to the Overclock API. Use zesOverclockGetControlCurrentValue instead.

ZE_APIEXPORT ze_result_t ZE_APICALL zesFrequencyOcGetVoltageTarget(zes_freq_handle_t hFrequency, double *pCurrentVoltageTarget, double *pCurrentVoltageOffset)#

Get the current overclocking voltage settings.

  • The application may call this function from simultaneous threads.

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

Parameters:

  • hFrequency – [in] Handle for the component.

  • pCurrentVoltageTarget – [out] Overclock voltage in Volts. This cannot be greater than the maxOcVoltage member of zes_oc_capabilities_t.

  • pCurrentVoltageOffset – [out] This voltage offset is applied to all points on the voltage/frequency curve, including the new overclock voltageTarget. Valid range is between the minOcVoltageOffset and maxOcVoltageOffset members of zes_oc_capabilities_t.

Returns:

zesFrequencyOcSetVoltageTarget#

Added in version 1.0

Deprecated since 1.8. Overclocking moved to the Overclock API. Use zesOverclockSetControlUserValue instead.

ZE_APIEXPORT ze_result_t ZE_APICALL zesFrequencyOcSetVoltageTarget(zes_freq_handle_t hFrequency, double CurrentVoltageTarget, double CurrentVoltageOffset)#

Set the current overclocking voltage settings.

  • The application may call this function from simultaneous threads.

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

Parameters:

  • hFrequency – [in] Handle for the component.

  • CurrentVoltageTarget – [in] Overclock voltage in Volts. This cannot be greater than the maxOcVoltage member of zes_oc_capabilities_t.

  • CurrentVoltageOffset – [in] This voltage offset is applied to all points on the voltage/frequency curve, include the new overclock voltageTarget. Valid range is between the minOcVoltageOffset and maxOcVoltageOffset members of zes_oc_capabilities_t.

Returns:

zesFrequencyOcSetMode#

Added in version 1.0

Deprecated since 1.8. Overclocking moved to the Overclock API. Use zesOverclockSetControlUserValue instead.

ZE_APIEXPORT ze_result_t ZE_APICALL zesFrequencyOcSetMode(zes_freq_handle_t hFrequency, zes_oc_mode_t CurrentOcMode)#

Set the current overclocking mode.

  • The application may call this function from simultaneous threads.

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

Parameters:

  • hFrequency – [in] Handle for the component.

  • CurrentOcMode – [in] Current Overclocking Mode zes_oc_mode_t.

Returns:

zesFrequencyOcGetMode#

Added in version 1.0

Deprecated since 1.8. Overclocking moved to the Overclock API. Use zesOverclockGetControlCurrentValue instead.

ZE_APIEXPORT ze_result_t ZE_APICALL zesFrequencyOcGetMode(zes_freq_handle_t hFrequency, zes_oc_mode_t *pCurrentOcMode)#

Get the current overclocking mode.

  • The application may call this function from simultaneous threads.

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

Parameters:

  • hFrequency – [in] Handle for the component.

  • pCurrentOcMode – [out] Current Overclocking Mode zes_oc_mode_t.

Returns:

zesFrequencyOcGetIccMax#

Added in version 1.0

Deprecated since 1.8. Overclocking moved to the Overclock API. Use zesOverclockGetControlCurrentValue instead.

ZE_APIEXPORT ze_result_t ZE_APICALL zesFrequencyOcGetIccMax(zes_freq_handle_t hFrequency, double *pOcIccMax)#

Get the maximum current limit setting.

  • The application may call this function from simultaneous threads.

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

Parameters:

  • hFrequency – [in] Handle for the component.

  • pOcIccMax – [in,out] Will contain the maximum current limit in Amperes on successful return.

Returns:

zesFrequencyOcSetIccMax#

Added in version 1.0

Deprecated since 1.8. Overclocking moved to the Overclock API. Use zesOverclockSetControlUserValue instead.

ZE_APIEXPORT ze_result_t ZE_APICALL zesFrequencyOcSetIccMax(zes_freq_handle_t hFrequency, double ocIccMax)#

Change the maximum current limit setting.

  • Setting ocIccMax to 0.0 will return the value to the factory default.

  • The application may call this function from simultaneous threads.

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

Parameters:

  • hFrequency – [in] Handle for the component.

  • ocIccMax – [in] The new maximum current limit in Amperes.

Returns:

zesFrequencyOcGetTjMax#

Added in version 1.0

Deprecated since 1.8. Overclocking moved to the Overclock API. Use zesOverclockGetControlCurrentValue instead.

ZE_APIEXPORT ze_result_t ZE_APICALL zesFrequencyOcGetTjMax(zes_freq_handle_t hFrequency, double *pOcTjMax)#

Get the maximum temperature limit setting.

  • The application may call this function from simultaneous threads.

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

Parameters:

  • hFrequency – [in] Handle for the component.

  • pOcTjMax – [in,out] Will contain the maximum temperature limit in degrees Celsius on successful return.

Returns:

zesFrequencyOcSetTjMax#

Added in version 1.0

Deprecated since 1.8. Overclocking moved to the Overclock API. Use zesOverclockSetControlUserValue instead.

ZE_APIEXPORT ze_result_t ZE_APICALL zesFrequencyOcSetTjMax(zes_freq_handle_t hFrequency, double ocTjMax)#

Change the maximum temperature limit setting.

  • Setting ocTjMax to 0.0 will return the value to the factory default.

  • The application may call this function from simultaneous threads.

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

Parameters:

  • hFrequency – [in] Handle for the component.

  • ocTjMax – [in] The new maximum temperature limit in degrees Celsius.

Returns:

Frequency - Deprecated Enums#

zes_oc_mode_t#

Added in version 1.0

Deprecated since 1.8. Overclocking moved to the Overclock API. Use zes_overclock_mode_t instead.

enum zes_oc_mode_t#

Overclocking modes

Values:

enumerator ZES_OC_MODE_OFF#

Overclocking if off - hardware is running using factory default voltages/frequencies.

enumerator ZES_OC_MODE_OVERRIDE#

Overclock override mode - In this mode, a fixed user-supplied voltage is applied independent of the frequency request. The maximum permitted frequency can also be increased. This mode disables INTERPOLATIVE and FIXED modes.

enumerator ZES_OC_MODE_INTERPOLATIVE#

Overclock interpolative mode - In this mode, the voltage/frequency curve can be extended with a new voltage/frequency point that will be interpolated. The existing voltage/frequency points can also be offset (up or down) by a fixed voltage. This mode disables FIXED and OVERRIDE modes.

enumerator ZES_OC_MODE_FIXED#

Overclocking fixed Mode - In this mode, hardware will disable most frequency throttling and lock the frequency and voltage at the specified overclock values. This mode disables OVERRIDE and INTERPOLATIVE modes. This mode can damage the part, most of the protections are disabled on this mode.

enumerator ZES_OC_MODE_FORCE_UINT32#

Value marking end of ZES_OC_MODE_* ENUMs.

Frequency - Deprecated Structures#

zes_oc_capabilities_t#

Added in version 1.0

Deprecated since 1.8. Overclocking moved to the Overclock API. Use zes_overclock_properties_t instead.

struct zes_oc_capabilities_t#

Overclocking properties

  • Provides all the overclocking capabilities and properties supported by the device for the frequency domain.

Public Members

zes_structure_type_t stype#

[in] type of this structure

const void *pNext#

[in][optional] must be null or a pointer to an extension-specific structure (i.e. contains stype and pNext).

ze_bool_t isOcSupported#

[out] Indicates if any overclocking features are supported on this frequency domain.

double maxFactoryDefaultFrequency#

[out] Factory default non-overclock maximum frequency in Mhz.

double maxFactoryDefaultVoltage#

[out] Factory default voltage used for the non-overclock maximum frequency in MHz.

double maxOcFrequency#

[out] Maximum hardware overclocking frequency limit in Mhz.

double minOcVoltageOffset#

[out] The minimum voltage offset that can be applied to the voltage/frequency curve. Note that this number can be negative.

double maxOcVoltageOffset#

[out] The maximum voltage offset that can be applied to the voltage/frequency curve.

double maxOcVoltage#

[out] The maximum overclock voltage that hardware supports.

ze_bool_t isTjMaxSupported#

[out] Indicates if the maximum temperature limit (TjMax) can be changed for this frequency domain.

ze_bool_t isIccMaxSupported#

[out] Indicates if the maximum current (IccMax) can be changed for this frequency domain.

ze_bool_t isHighVoltModeCapable#

[out] Indicates if this frequency domains supports a feature to set very high voltages.

ze_bool_t isHighVoltModeEnabled#

[out] Indicates if very high voltages are permitted on this frequency domain.

ze_bool_t isExtendedModeSupported#

[out] Indicates if the extended overclocking features are supported. If this is supported, increments are on 1 Mhz basis.

ze_bool_t isFixedModeSupported#

[out] Indicates if the fixed mode is supported. In this mode, hardware will disable most frequency throttling and lock the frequency and voltage at the specified overclock values.