Peak Tops Limiter

Functions

Peak Tops Limiter

Functions
amdsmi_status_t	amdsmi_get_gpu_ptl_state (amdsmi_processor_handle processor_handle, bool *enabled)
	Get PTL enable/disable state.
amdsmi_status_t	amdsmi_set_gpu_ptl_state (amdsmi_processor_handle processor_handle, bool enable)
	Set PTL enable/disable state.
amdsmi_status_t	amdsmi_get_gpu_ptl_formats (amdsmi_processor_handle processor_handle, amdsmi_ptl_data_format_t *data_format1, amdsmi_ptl_data_format_t *data_format2)
	Get PTL (Peak Tops Limiter) formats for the processor.
amdsmi_status_t	amdsmi_set_gpu_ptl_formats (amdsmi_processor_handle processor_handle, amdsmi_ptl_data_format_t data_format1, amdsmi_ptl_data_format_t data_format2)
	Set PTL with specified preferred data formats.

Detailed Description

Function Documentation

◆ amdsmi_get_gpu_ptl_state()

amdsmi_status_t amdsmi_get_gpu_ptl_state	(	amdsmi_processor_handle	processor_handle,
		bool *	enabled
	)

Get PTL enable/disable state.

Platform:

gpu_bm_linux

host

This function retrieves whether PTL (Peak Tops Limiter) is currently enabled or disabled for the specified processor. This is a simple state query that returns the current PTL operational state without detailed configuration.

Parameters

[in]	processor_handle	Device which to query
[out]	enabled	Pointer to boolean that will be set to true if PTL is enabled, false if PTL is disabled

Returns

amdsmi_status_t | AMDSMI_STATUS_SUCCESS on success, AMDSMI_STATUS_NOT_SUPPORTED if PTL is not supported on this device, non-zero on other failures

◆ amdsmi_set_gpu_ptl_state()

amdsmi_status_t amdsmi_set_gpu_ptl_state	(	amdsmi_processor_handle	processor_handle,
		bool	enable
	)

Set PTL enable/disable state.

Platform:

gpu_bm_linux

host

This function enables or disables PTL (Peak Tops Limiter) operation. Use amdsmi_set_gpu_ptl_enable_with_formats() for more control over the preferred data formats when enabling.

Parameters

[in]	processor_handle	Device to configure
[in]	enable	Boolean flag: true to enable PTL with default formats, false to disable PTL

Returns

amdsmi_status_t | AMDSMI_STATUS_SUCCESS on success, non-zero on fail

◆ amdsmi_get_gpu_ptl_formats()

amdsmi_status_t amdsmi_get_gpu_ptl_formats	(	amdsmi_processor_handle	processor_handle,
		amdsmi_ptl_data_format_t *	data_format1,
		amdsmi_ptl_data_format_t *	data_format2
	)

Get PTL (Peak Tops Limiter) formats for the processor.

Platform:

gpu_bm_linux

host

This function retrieves the current PTL fromats for the specified processor. PTL constrains the product to never deliver more than a specified TOPS/second.

Parameters

[in]	processor_handle	Device which to query
[out]	data_format1	Pointer to first preferred data format that receives peak performance
[out]	data_format2	Pointer to second preferred data format that receives peak performance

Returns

amdsmi_status_t | AMDSMI_STATUS_SUCCESS on success, AMDSMI_STATUS_NOT_SUPPORTED if PTL is not supported on this device, non-zero on other failures

◆ amdsmi_set_gpu_ptl_formats()

amdsmi_status_t amdsmi_set_gpu_ptl_formats	(	amdsmi_processor_handle	processor_handle,
		amdsmi_ptl_data_format_t	data_format1,
		amdsmi_ptl_data_format_t	data_format2
	)

Set PTL with specified preferred data formats.

Platform:

gpu_bm_linux

host

This function sets PTL with the specified preferred data format pair. PTL must be enabled first before calling this function using amdsmi_set_gpu_ptl_state. The two specified formats will receive accurate performance monitoring and peak performance. F8 and XF32 formats always receive peak performance regardless of this setting.

Parameters

[in]	processor_handle	Device to configure
[in]	data_format1	First preferred data format (must be from the limited set: I8, F16, BF16, F32, F64)
[in]	data_format2	Second preferred data format (must be from the limited set: I8, F16, BF16, F32, F64, and different from data_format1)

Returns

amdsmi_status_t | AMDSMI_STATUS_SUCCESS on success, AMDSMI_STATUS_NOT_SUPPORTED if PTL is not supported on this device, non-zero on other failures